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": "/var/opt/motion2/server/api/cmHopper/index.js",
17 "groupTitle": "/var/opt/motion2/server/api/cmHopper/index.js"
21 "url": "/api/square/projects/{id}/users",
22 "title": "Removes user permissions from a Project",
25 "title": "Example usage:",
26 "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31 "filename": "server/api/squareProject/index.js",
32 "group": "/var/opt/motion2/server/api/squareProject/index.js",
33 "groupTitle": "/var/opt/motion2/server/api/squareProject/index.js",
34 "name": "DeleteApiSquareProjectsIdUsers"
38 "url": "/api/square/projects/{id}/users",
39 "title": "Gets users permissions from Project",
42 "title": "Example usage:",
43 "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
48 "filename": "server/api/squareProject/index.js",
49 "group": "/var/opt/motion2/server/api/squareProject/index.js",
50 "groupTitle": "/var/opt/motion2/server/api/squareProject/index.js",
51 "name": "GetApiSquareProjectsIdUsers"
55 "url": "/api/square/projects/{id}/users",
56 "title": "Adds user permissions to a Project",
59 "title": "Example usage:",
60 "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",
65 "filename": "server/api/squareProject/index.js",
66 "group": "/var/opt/motion2/server/api/squareProject/index.js",
67 "groupTitle": "/var/opt/motion2/server/api/squareProject/index.js",
68 "name": "PostApiSquareProjectsIdUsers"
72 "url": "/api/actions/{id}",
73 "title": "Deletes a Action",
76 "title": "Example usage:",
77 "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",
81 "name": "DeleteActions",
83 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
85 "filename": "server/api/action/index.js",
86 "groupTitle": "Actions"
90 "url": "/api/actions/{id}",
91 "title": "Update an existing Action",
94 "title": "Example usage:",
95 "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
99 "name": "updateActions",
101 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
103 "filename": "server/api/action/index.js",
104 "groupTitle": "Actions"
108 "url": "/api/analytics/custom_reports",
109 "title": "Creates a new Analytic Custom Report",
112 "title": "Example usage:",
113 "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",
117 "name": "CreateAnalytic_Custom_Reports",
118 "group": "Analytic_Custom_Reports",
133 "field": "description",
154 "field": "conditions",
167 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
169 "filename": "server/api/analyticCustomReport/index.js",
170 "groupTitle": "Analytic_Custom_Reports"
174 "url": "/api/analytics/custom_reports/{id}",
175 "title": "Deletes a Analytic Custom Report",
178 "title": "Example usage:",
179 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",
183 "name": "DeleteAnalytic_Custom_Reports",
184 "group": "Analytic_Custom_Reports",
185 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
187 "filename": "server/api/analyticCustomReport/index.js",
188 "groupTitle": "Analytic_Custom_Reports"
192 "url": "/api/analytics/custom_reports",
193 "title": "Gets a list of Analytic Custom Reports",
196 "title": "Example usage:",
197 "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",
201 "name": "GetAnalytic_Custom_Reports",
202 "group": "Analytic_Custom_Reports",
203 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
205 "filename": "server/api/analyticCustomReport/index.js",
206 "groupTitle": "Analytic_Custom_Reports"
210 "url": "/api/analytics/custom_reports/{id}",
211 "title": "Gets a single Analytic Custom Report",
214 "title": "Example usage:",
215 "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",
219 "name": "ShowAnalytic_Custom_Reports",
220 "group": "Analytic_Custom_Reports",
221 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
223 "filename": "server/api/analyticCustomReport/index.js",
224 "groupTitle": "Analytic_Custom_Reports"
228 "url": "/api/analytics/custom_reports/{id}/preview",
229 "title": "Report Preview",
232 "title": "Example usage:",
233 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",
238 "group": "Analytic_Custom_Reports",
239 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
241 "filename": "server/api/analyticCustomReport/index.js",
242 "groupTitle": "Analytic_Custom_Reports"
246 "url": "/api/analytics/custom_reports/{id}/query",
247 "title": "Report Query SQL",
250 "title": "Example usage:",
251 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",
256 "group": "Analytic_Custom_Reports",
257 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
259 "filename": "server/api/analyticCustomReport/index.js",
260 "groupTitle": "Analytic_Custom_Reports"
264 "url": "/api/analytics/custom_reports/{id}/run",
265 "title": "Report Run",
268 "title": "Example usage:",
269 "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",
274 "group": "Analytic_Custom_Reports",
275 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
277 "filename": "server/api/analyticCustomReport/index.js",
278 "groupTitle": "Analytic_Custom_Reports"
282 "url": "/api/analytics/custom_reports/{id}",
283 "title": "Update an existing Analytic Custom Report",
286 "title": "Example usage:",
287 "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",
291 "name": "updateAnalytic_Custom_Reports",
292 "group": "Analytic_Custom_Reports",
293 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
295 "filename": "server/api/analyticCustomReport/index.js",
296 "groupTitle": "Analytic_Custom_Reports"
300 "url": "/api/analytics/default_reports",
301 "title": "Creates a new Analytic Default Report",
304 "title": "Example usage:",
305 "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",
309 "name": "CreateAnalytic_Default_Reports",
310 "group": "Analytic_Default_Reports",
325 "field": "description",
346 "field": "conditions",
359 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
361 "filename": "server/api/analyticDefaultReport/index.js",
362 "groupTitle": "Analytic_Default_Reports"
366 "url": "/api/analytics/default_reports/{id}",
367 "title": "Deletes a Analytic Default Report",
370 "title": "Example usage:",
371 "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",
375 "name": "DeleteAnalytic_Default_Reports",
376 "group": "Analytic_Default_Reports",
377 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
379 "filename": "server/api/analyticDefaultReport/index.js",
380 "groupTitle": "Analytic_Default_Reports"
384 "url": "/api/analytics/default_reports",
385 "title": "Gets a list of Analytic Default Reports",
388 "title": "Example usage:",
389 "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",
393 "name": "GetAnalytic_Default_Reports",
394 "group": "Analytic_Default_Reports",
395 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
397 "filename": "server/api/analyticDefaultReport/index.js",
398 "groupTitle": "Analytic_Default_Reports"
402 "url": "/api/analytics/default_reports/{id}",
403 "title": "Gets a single Analytic Default Report",
406 "title": "Example usage:",
407 "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",
411 "name": "ShowAnalytic_Default_Reports",
412 "group": "Analytic_Default_Reports",
413 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
415 "filename": "server/api/analyticDefaultReport/index.js",
416 "groupTitle": "Analytic_Default_Reports"
420 "url": "/api/analytics/default_reports/{id}/preview",
421 "title": "Report Preview",
424 "title": "Example usage:",
425 "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",
430 "group": "Analytic_Default_Reports",
431 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
433 "filename": "server/api/analyticDefaultReport/index.js",
434 "groupTitle": "Analytic_Default_Reports"
438 "url": "/api/analytics/default_reports/{id}/query",
439 "title": "Report Query SQL",
442 "title": "Example usage:",
443 "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",
448 "group": "Analytic_Default_Reports",
449 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
451 "filename": "server/api/analyticDefaultReport/index.js",
452 "groupTitle": "Analytic_Default_Reports"
456 "url": "/api/analytics/default_reports/{id}/run",
457 "title": "Report Run",
460 "title": "Example usage:",
461 "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",
466 "group": "Analytic_Default_Reports",
467 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
469 "filename": "server/api/analyticDefaultReport/index.js",
470 "groupTitle": "Analytic_Default_Reports"
474 "url": "/api/analytics/default_reports/{id}",
475 "title": "Update an existing Analytic Default Report",
478 "title": "Example usage:",
479 "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",
483 "name": "updateAnalytic_Default_Reports",
484 "group": "Analytic_Default_Reports",
485 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
487 "filename": "server/api/analyticDefaultReport/index.js",
488 "groupTitle": "Analytic_Default_Reports"
492 "url": "/api/analytics/extracted_reports",
493 "title": "Creates a new Analytic Extracted Report",
496 "title": "Example usage:",
497 "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",
501 "name": "CreateAnalytic_Extacted_Reports",
502 "group": "Analytic_Extracted_Reports",
543 "field": "startDate",
582 "field": "reportType",
588 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
590 "filename": "server/api/analyticExtractedReport/index.js",
591 "groupTitle": "Analytic_Extracted_Reports"
595 "url": "/api/analytics/extracted_reports/{id}",
596 "title": "Deletes a Analytic Extracted Report",
599 "title": "Example usage:",
600 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",
604 "name": "DeleteAnalytic_Extacted_Reports",
605 "group": "Analytic_Extracted_Reports",
606 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
608 "filename": "server/api/analyticExtractedReport/index.js",
609 "groupTitle": "Analytic_Extracted_Reports"
613 "url": "/api/analytics/extracted_reports",
614 "title": "Gets a list of Analytic Extacted Reports",
617 "title": "Example usage:",
618 "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",
622 "name": "GetAnalytic_Extacted_Reports",
623 "group": "Analytic_Extracted_Reports",
624 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
626 "filename": "server/api/analyticExtractedReport/index.js",
627 "groupTitle": "Analytic_Extracted_Reports"
631 "url": "/api/analytics/extracted_reports/{id}",
632 "title": "Gets a single Analytic Extracted Report",
635 "title": "Example usage:",
636 "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",
640 "name": "ShowAnalytic_Extacted_Reports",
641 "group": "Analytic_Extracted_Reports",
642 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
644 "filename": "server/api/analyticExtractedReport/index.js",
645 "groupTitle": "Analytic_Extracted_Reports"
649 "url": "/api/analytics/extracted_reports/{id}/download",
650 "title": "Download Extracted Report",
653 "title": "Example usage:",
654 "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",
659 "group": "Analytic_Extracted_Reports",
660 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
662 "filename": "server/api/analyticExtractedReport/index.js",
663 "groupTitle": "Analytic_Extracted_Reports"
667 "url": "/api/analytics/extracted_reports/{id}",
668 "title": "Update an existing Analytic Extracted Report",
671 "title": "Example usage:",
672 "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",
676 "name": "updateAnalytic_Extacted_Reports",
677 "group": "Analytic_Extracted_Reports",
678 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
680 "filename": "server/api/analyticExtractedReport/index.js",
681 "groupTitle": "Analytic_Extracted_Reports"
685 "url": "/api/analytics/field_reports/create_many",
686 "title": "Creates many Analytic Field Reports",
689 "title": "Example usage:",
690 "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",
694 "name": "BulkCreateAnalytic_Field_Reports",
695 "group": "Analytic_Field_Reports",
751 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
753 "filename": "server/api/analyticFieldReport/index.js",
754 "groupTitle": "Analytic_Field_Reports"
758 "url": "/api/analytics/field_reports/destroy_many?ids={ids}",
759 "title": "Deletes many Analytic Field Reports",
762 "title": "Example usage:",
763 "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",
767 "name": "BulkDeleteAnalytic_Field_Reports",
768 "group": "Analytic_Field_Reports",
769 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
771 "filename": "server/api/analyticFieldReport/index.js",
772 "groupTitle": "Analytic_Field_Reports"
776 "url": "/api/analytics/field_reports",
777 "title": "Creates a new Analytic Field Report",
780 "title": "Example usage:",
781 "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",
785 "name": "CreateAnalytic_Field_Reports",
786 "group": "Analytic_Field_Reports",
842 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
844 "filename": "server/api/analyticFieldReport/index.js",
845 "groupTitle": "Analytic_Field_Reports"
849 "url": "/api/analytics/field_reports/{id}",
850 "title": "Deletes a Analytic Field Report",
853 "title": "Example usage:",
854 "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",
858 "name": "DeleteAnalytic_Field_Reports",
859 "group": "Analytic_Field_Reports",
860 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
862 "filename": "server/api/analyticFieldReport/index.js",
863 "groupTitle": "Analytic_Field_Reports"
867 "url": "/api/analytics/field_reports",
868 "title": "Gets a list of Analytic Field Reports",
871 "title": "Example usage:",
872 "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",
876 "name": "GetAnalytic_Field_Reports",
877 "group": "Analytic_Field_Reports",
878 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
880 "filename": "server/api/analyticFieldReport/index.js",
881 "groupTitle": "Analytic_Field_Reports"
885 "url": "/api/analytics/field_reports/{id}",
886 "title": "Gets a single Analytic Field Report",
889 "title": "Example usage:",
890 "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",
894 "name": "ShowAnalytic_Field_Reports",
895 "group": "Analytic_Field_Reports",
896 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
898 "filename": "server/api/analyticFieldReport/index.js",
899 "groupTitle": "Analytic_Field_Reports"
903 "url": "/api/analytics/field_reports/{id}/create_many",
904 "title": "Rewrite fields set",
907 "title": "Example usage:",
908 "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
913 "group": "Analytic_Field_Reports",
914 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
916 "filename": "server/api/analyticFieldReport/index.js",
917 "groupTitle": "Analytic_Field_Reports"
921 "url": "/api/analytics/field_reports/{id}",
922 "title": "Update an existing Analytic Field Report",
925 "title": "Example usage:",
926 "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",
930 "name": "updateAnalytic_Field_Reports",
931 "group": "Analytic_Field_Reports",
932 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
934 "filename": "server/api/analyticFieldReport/index.js",
935 "groupTitle": "Analytic_Field_Reports"
939 "url": "/api/analytics/metrics",
940 "title": "Creates a new Analytic Metrics",
943 "title": "Example usage:",
944 "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
948 "name": "CreateAnalytic_Metric",
949 "group": "Analytic_Metrics",
978 "field": "description",
984 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
986 "filename": "server/api/analyticMetric/index.js",
987 "groupTitle": "Analytic_Metrics"
991 "url": "/api/analytics/metrics/{id}",
992 "title": "Deletes a Analytic Metrics",
995 "title": "Example usage:",
996 "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",
1000 "name": "DeleteAnalytic_Metric",
1001 "group": "Analytic_Metrics",
1002 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1004 "filename": "server/api/analyticMetric/index.js",
1005 "groupTitle": "Analytic_Metrics"
1009 "url": "/api/analytics/metrics",
1010 "title": "Gets a list of Analytic Metric",
1013 "title": "Example usage:",
1014 "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",
1018 "name": "GetAnalytic_Metric",
1019 "group": "Analytic_Metrics",
1020 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
1022 "filename": "server/api/analyticMetric/index.js",
1023 "groupTitle": "Analytic_Metrics"
1027 "url": "/api/analytics/metrics/{id}",
1028 "title": "Gets a single Analytic Metrics",
1031 "title": "Example usage:",
1032 "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",
1036 "name": "ShowAnalytic_Metric",
1037 "group": "Analytic_Metrics",
1038 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1040 "filename": "server/api/analyticMetric/index.js",
1041 "groupTitle": "Analytic_Metrics"
1045 "url": "/api/analytics/metrics/{id}",
1046 "title": "Update an existing Analytic Metrics",
1049 "title": "Example usage:",
1050 "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",
1054 "name": "updateAnalytic_Metric",
1055 "group": "Analytic_Metrics",
1056 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1058 "filename": "server/api/analyticMetric/index.js",
1059 "groupTitle": "Analytic_Metrics"
1063 "url": "/api/analytics/tree_reports",
1064 "title": "Creates a new Analytic Tree Report",
1067 "title": "Example usage:",
1068 "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",
1072 "name": "CreateAnalytic_Tree_Reports",
1073 "group": "Analytic_Tree_Reports",
1087 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1089 "filename": "server/api/analyticTreeReport/index.js",
1090 "groupTitle": "Analytic_Tree_Reports"
1094 "url": "/api/analytics/tree_reports/{id}",
1095 "title": "Deletes a Analytic Tree Report",
1098 "title": "Example usage:",
1099 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",
1103 "name": "DeleteAnalytic_Tree_Reports",
1104 "group": "Analytic_Tree_Reports",
1105 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1107 "filename": "server/api/analyticTreeReport/index.js",
1108 "groupTitle": "Analytic_Tree_Reports"
1112 "url": "/api/analytics/tree_reports",
1113 "title": "Gets a list of Analytic Tree Reports",
1116 "title": "Example usage:",
1117 "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",
1121 "name": "GetAnalytic_Tree_Reports",
1122 "group": "Analytic_Tree_Reports",
1123 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
1125 "filename": "server/api/analyticTreeReport/index.js",
1126 "groupTitle": "Analytic_Tree_Reports"
1130 "url": "/api/analytics/tree_reports/{id}",
1131 "title": "Gets a single Analytic Tree Report",
1134 "title": "Example usage:",
1135 "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",
1139 "name": "ShowAnalytic_Tree_Reports",
1140 "group": "Analytic_Tree_Reports",
1141 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1143 "filename": "server/api/analyticTreeReport/index.js",
1144 "groupTitle": "Analytic_Tree_Reports"
1148 "url": "/api/analytics/tree_reports/{id}",
1149 "title": "Update an existing Analytic Tree Report",
1152 "title": "Example usage:",
1153 "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",
1157 "name": "updateAnalytic_Tree_Reports",
1158 "group": "Analytic_Tree_Reports",
1159 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1161 "filename": "server/api/analyticTreeReport/index.js",
1162 "groupTitle": "Analytic_Tree_Reports"
1166 "url": "/api/attachments/clone",
1167 "title": "Clone an existing Attachment",
1170 "title": "Example usage:",
1171 "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1175 "name": "CloneAttachments",
1176 "group": "Attachments",
1177 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1179 "filename": "server/api/attachment/index.js",
1180 "groupTitle": "Attachments"
1184 "url": "/api/attachments/{id}",
1185 "title": "Deletes a Attachment",
1188 "title": "Example usage:",
1189 "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",
1193 "name": "DeleteAttachments",
1194 "group": "Attachments",
1195 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1197 "filename": "server/api/attachment/index.js",
1198 "groupTitle": "Attachments"
1202 "url": "/api/attachments",
1203 "title": "Gets a list of Attachments",
1206 "title": "Example usage:",
1207 "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",
1211 "name": "GetAttachments",
1212 "group": "Attachments",
1213 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
1215 "filename": "server/api/attachment/index.js",
1216 "groupTitle": "Attachments"
1220 "url": "/api/attachments/{id}",
1221 "title": "Gets a single Attachment",
1224 "title": "Example usage:",
1225 "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",
1229 "name": "ShowAttachments",
1230 "group": "Attachments",
1231 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1233 "filename": "server/api/attachment/index.js",
1234 "groupTitle": "Attachments"
1238 "url": "/api/attachments",
1239 "title": "Add attachment",
1242 "title": "Example usage:",
1243 "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
1248 "group": "Attachments",
1249 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1251 "filename": "server/api/attachment/index.js",
1252 "groupTitle": "Attachments"
1256 "url": "/api/attachments/:id/download",
1257 "title": "Download attachment",
1260 "title": "Example usage:",
1261 "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",
1266 "group": "Attachments",
1267 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1269 "filename": "server/api/attachment/index.js",
1270 "groupTitle": "Attachments"
1274 "url": "/api/chat/interactions/{id}/attachment_download",
1275 "title": "Download attachment",
1278 "title": "Example usage:",
1279 "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",
1284 "group": "Attachments",
1285 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1287 "filename": "server/api/chatInteraction/index.js",
1288 "groupTitle": "Attachments"
1292 "url": "/api/attachments/{id}",
1293 "title": "Update an existing Attachment",
1296 "title": "Example usage:",
1297 "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1301 "name": "updateAttachments",
1302 "group": "Attachments",
1303 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1305 "filename": "server/api/attachment/index.js",
1306 "groupTitle": "Attachments"
1310 "url": "/api/auth/local/forgot",
1311 "title": "Creates a new password reset token",
1314 "title": "Example usage:",
1315 "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1319 "name": "Local_Forgot_Password",
1320 "group": "Authentication",
1334 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1336 "filename": "server/api/authLocal/index.js",
1337 "groupTitle": "Authentication"
1341 "url": "/api/auth/local/reset/:token",
1342 "title": "Reset user password",
1345 "title": "Example usage:",
1346 "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1350 "name": "Local_Reset_Password",
1351 "group": "Authentication",
1359 "field": "password",
1365 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1367 "filename": "server/api/authLocal/index.js",
1368 "groupTitle": "Authentication"
1372 "url": "/api/auth/activedirectory",
1373 "title": "Creates a new User token",
1376 "title": "Example usage:",
1377 "content": "curl https://{domain}/api/auth/activedirectory -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1381 "name": "Local_login",
1382 "group": "Authentication",
1397 "field": "password",
1403 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1405 "filename": "server/api/authActiveDirectory/index.js",
1406 "groupTitle": "Authentication"
1410 "url": "/api/auth/google",
1411 "title": "Creates a new User token",
1414 "title": "Example usage:",
1415 "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1419 "name": "Local_login",
1420 "group": "Authentication",
1435 "field": "password",
1441 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1443 "filename": "server/api/authGoogle/index.js",
1444 "groupTitle": "Authentication"
1448 "url": "/api/auth/local",
1449 "title": "Creates a new User token",
1452 "title": "Example usage:",
1453 "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1457 "name": "Local_login",
1458 "group": "Authentication",
1473 "field": "password",
1479 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1481 "filename": "server/api/authLocal/index.js",
1482 "groupTitle": "Authentication"
1486 "url": "/api/automations",
1487 "title": "Creates a new Automation",
1490 "title": "Example usage:",
1491 "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1495 "name": "CreateAutomations",
1496 "group": "Automations",
1518 "field": "description",
1538 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1540 "filename": "server/api/automation/index.js",
1541 "groupTitle": "Automations"
1545 "url": "/api/automations/{id}",
1546 "title": "Deletes a Automation",
1549 "title": "Example usage:",
1550 "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
1554 "name": "DeleteAutomations",
1555 "group": "Automations",
1556 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1558 "filename": "server/api/automation/index.js",
1559 "groupTitle": "Automations"
1563 "url": "/api/automations",
1564 "title": "Gets a list of Automations",
1567 "title": "Example usage:",
1568 "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
1572 "name": "GetAutomations",
1573 "group": "Automations",
1574 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
1576 "filename": "server/api/automation/index.js",
1577 "groupTitle": "Automations"
1581 "url": "/api/automations/{id}",
1582 "title": "Gets a single Automation",
1585 "title": "Example usage:",
1586 "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
1590 "name": "ShowAutomations",
1591 "group": "Automations",
1592 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1594 "filename": "server/api/automation/index.js",
1595 "groupTitle": "Automations"
1599 "url": "/api/automations/{id}/actions",
1600 "title": "Creates new actions",
1603 "title": "Example usage:",
1604 "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",
1608 "name": "addActions",
1609 "group": "Automations",
1625 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
1632 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
1639 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
1646 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
1679 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1681 "filename": "server/api/automation/index.js",
1682 "groupTitle": "Automations"
1686 "url": "/api/automations/{id}/conditions",
1687 "title": "Creates new conditions",
1690 "title": "Example usage:",
1691 "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",
1695 "name": "addConditions",
1696 "group": "Automations",
1718 "field": "operator",
1731 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1733 "filename": "server/api/automation/index.js",
1734 "groupTitle": "Automations"
1738 "url": "/api/automations/{id}/actions",
1739 "title": "Gets Automation Actions",
1742 "title": "Example usage:",
1743 "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
1747 "name": "getActions",
1748 "group": "Automations",
1749 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1751 "filename": "server/api/automation/index.js",
1752 "groupTitle": "Automations"
1756 "url": "/api/automations/{id}/conditions",
1757 "title": "Gets Automation Conditions",
1760 "title": "Example usage:",
1761 "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
1765 "name": "getConditions",
1766 "group": "Automations",
1767 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1769 "filename": "server/api/automation/index.js",
1770 "groupTitle": "Automations"
1774 "url": "/api/automations/{id}",
1775 "title": "Update an existing Automation",
1778 "title": "Example usage:",
1779 "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1783 "name": "updateAutomations",
1784 "group": "Automations",
1785 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1787 "filename": "server/api/automation/index.js",
1788 "groupTitle": "Automations"
1792 "url": "/api/canned_answers",
1793 "title": "Create a new canned answer",
1796 "title": "Example usage:",
1797 "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1802 "group": "Canned_Answers",
1803 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1805 "filename": "server/api/cannedAnswer/index.js",
1806 "groupTitle": "Canned_Answers"
1810 "url": "/api/canned_answers/{id}",
1811 "title": "Deletes a Canned Answer",
1814 "title": "Example usage:",
1815 "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
1819 "name": "DeleteCanned_Answers",
1820 "group": "Canned_Answers",
1821 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1823 "filename": "server/api/cannedAnswer/index.js",
1824 "groupTitle": "Canned_Answers"
1828 "url": "/api/canned_answers",
1829 "title": "Gets a list of Canned Answers",
1832 "title": "Example usage:",
1833 "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
1837 "name": "GetCanned_Answers",
1838 "group": "Canned_Answers",
1839 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
1841 "filename": "server/api/cannedAnswer/index.js",
1842 "groupTitle": "Canned_Answers"
1846 "url": "/api/canned_answers/{id}",
1847 "title": "Gets a single Canned Answer",
1850 "title": "Example usage:",
1851 "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
1855 "name": "ShowCanned_Answers",
1856 "group": "Canned_Answers",
1857 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1859 "filename": "server/api/cannedAnswer/index.js",
1860 "groupTitle": "Canned_Answers"
1864 "url": "/api/canned_answers/{id}",
1865 "title": "Update an existing Canned Answer",
1868 "title": "Example usage:",
1869 "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",
1873 "name": "updateCanned_Answers",
1874 "group": "Canned_Answers",
1875 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1877 "filename": "server/api/cannedAnswer/index.js",
1878 "groupTitle": "Canned_Answers"
1882 "url": "/chat/internal/users",
1883 "title": "Gets Users Last Messages",
1886 "title": "Example usage:",
1887 "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password} -X GET",
1891 "name": "getLastUsersMessages",
1892 "group": "ChatInternalMessage",
1893 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1895 "filename": "server/api/chatInternalMessage/index.js",
1896 "groupTitle": "ChatInternalMessage"
1900 "url": "/api/chat/applications/{id}",
1901 "title": "Deletes a Application",
1904 "title": "Example usage:",
1905 "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
1909 "name": "DeleteApplications",
1910 "group": "Chat_Applications",
1911 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1913 "filename": "server/api/chatApplication/index.js",
1914 "groupTitle": "Chat_Applications"
1918 "url": "/api/chat/applications/{id}",
1919 "title": "Gets a single Application",
1922 "title": "Example usage:",
1923 "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
1927 "name": "ShowApplications",
1928 "group": "Chat_Applications",
1929 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1931 "filename": "server/api/chatApplication/index.js",
1932 "groupTitle": "Chat_Applications"
1936 "url": "/api/chat/applications/{id}",
1937 "title": "Update an existing Application",
1940 "title": "Example usage:",
1941 "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",
1945 "name": "updateApplications",
1946 "group": "Chat_Applications",
1947 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1949 "filename": "server/api/chatApplication/index.js",
1950 "groupTitle": "Chat_Applications"
1954 "url": "/api/chat/groups",
1955 "title": "Creates a new Group",
1958 "title": "Example usage:",
1959 "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1963 "name": "CreateGroups",
1964 "group": "Chat_Groups",
1979 "field": "description",
1992 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1994 "filename": "server/api/chatGroup/index.js",
1995 "groupTitle": "Chat_Groups"
1999 "url": "/api/chat/groups/{id}",
2000 "title": "Deletes a Group",
2003 "title": "Example usage:",
2004 "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
2008 "name": "DeleteGroups",
2009 "group": "Chat_Groups",
2010 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2012 "filename": "server/api/chatGroup/index.js",
2013 "groupTitle": "Chat_Groups"
2017 "url": "/api/chat/groups/describe",
2018 "title": "Gets table info about Groups",
2021 "title": "Example usage:",
2022 "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
2026 "name": "DescribeGroups",
2027 "group": "Chat_Groups",
2028 "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>",
2030 "filename": "server/api/chatGroup/index.js",
2031 "groupTitle": "Chat_Groups"
2035 "url": "/api/chat/groups",
2036 "title": "Gets a list of Groups",
2039 "title": "Example usage:",
2040 "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
2044 "name": "GetGroups",
2045 "group": "Chat_Groups",
2046 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2048 "filename": "server/api/chatGroup/index.js",
2049 "groupTitle": "Chat_Groups"
2053 "url": "/api/chat/groups/{id}/members",
2054 "title": "Removes members from a group",
2057 "title": "Example usage:",
2058 "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2062 "name": "RemoveMembers",
2063 "group": "Chat_Groups",
2064 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2066 "filename": "server/api/chatGroup/index.js",
2067 "groupTitle": "Chat_Groups"
2071 "url": "/api/chat/groups/{id}",
2072 "title": "Gets a single Group",
2075 "title": "Example usage:",
2076 "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
2080 "name": "ShowGroups",
2081 "group": "Chat_Groups",
2082 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2084 "filename": "server/api/chatGroup/index.js",
2085 "groupTitle": "Chat_Groups"
2089 "url": "/api/chat/groups/{id}/members",
2090 "title": "Add members to chat group",
2093 "title": "Example usage:",
2094 "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",
2098 "name": "addMembers",
2099 "group": "Chat_Groups",
2100 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2102 "filename": "server/api/chatGroup/index.js",
2103 "groupTitle": "Chat_Groups"
2107 "url": "/api/chat/groups/{id}/messages",
2108 "title": "Creates a new group message",
2111 "title": "Example usage:",
2112 "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2116 "name": "addMessage",
2117 "group": "Chat_Groups",
2118 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2120 "filename": "server/api/chatGroup/index.js",
2121 "groupTitle": "Chat_Groups"
2125 "url": "/api/chat/groups/{id}/members",
2126 "title": "Gets Members",
2129 "title": "Example usage:",
2130 "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
2134 "name": "getMembers",
2135 "group": "Chat_Groups",
2136 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2138 "filename": "server/api/chatGroup/index.js",
2139 "groupTitle": "Chat_Groups"
2143 "url": "/api/chat/groups/{id}/messages",
2144 "title": "Gets Messages",
2147 "title": "Example usage:",
2148 "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
2152 "name": "getMessages",
2153 "group": "Chat_Groups",
2154 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2156 "filename": "server/api/chatGroup/index.js",
2157 "groupTitle": "Chat_Groups"
2161 "url": "/api/chat/groups/{id}/unread",
2162 "title": "Get unread chat group messages",
2165 "title": "Example usage:",
2166 "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
2171 "group": "Chat_Groups",
2172 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2174 "filename": "server/api/chatGroup/index.js",
2175 "groupTitle": "Chat_Groups"
2179 "url": "/api/chat/groups/{id}",
2180 "title": "Update an existing Group",
2183 "title": "Example usage:",
2184 "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",
2188 "name": "updateGroups",
2189 "group": "Chat_Groups",
2190 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2192 "filename": "server/api/chatGroup/index.js",
2193 "groupTitle": "Chat_Groups"
2197 "url": "/api/chat/interactions/{id}/tags",
2198 "title": "Add tags to the interaction",
2201 "title": "Example usage:",
2202 "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",
2207 "group": "Chat_Interactions",
2208 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2210 "filename": "server/api/chatInteraction/index.js",
2211 "groupTitle": "Chat_Interactions"
2215 "url": "/api/chat/interactions",
2216 "title": "Creates a new Interaction",
2219 "title": "Example usage:",
2220 "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2224 "name": "CreateInteractions",
2225 "group": "Chat_Interactions",
2240 "field": "ratingValue",
2251 "field": "ratingType",
2258 "field": "ratingMessage",
2265 "field": "pathTranscript",
2272 "field": "mailTranscript",
2279 "field": "closedAt",
2286 "field": "disposition",
2293 "field": "secondDisposition",
2300 "field": "thirdDisposition",
2314 "field": "browserName",
2321 "field": "browserVersion",
2335 "field": "osVersion",
2342 "field": "deviceModel",
2349 "field": "deviceVendor",
2356 "field": "deviceType",
2370 "field": "customerIp",
2377 "field": "formData",
2384 "field": "read1stAt",
2391 "field": "lastMsgAt",
2402 "field": "lastMsgDirection",
2409 "field": "closeReason",
2416 "field": "customerPort",
2423 "field": "vidaooSessionId",
2430 "field": "autoreplyExecuted",
2436 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2438 "filename": "server/api/chatInteraction/index.js",
2439 "groupTitle": "Chat_Interactions"
2443 "url": "/api/chat/interactions/{id}",
2444 "title": "Deletes a Interaction",
2447 "title": "Example usage:",
2448 "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2452 "name": "DeleteInteractions",
2453 "group": "Chat_Interactions",
2454 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2456 "filename": "server/api/chatInteraction/index.js",
2457 "groupTitle": "Chat_Interactions"
2461 "url": "/api/chat/interactions/describe",
2462 "title": "Gets table info about Interactions",
2465 "title": "Example usage:",
2466 "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2470 "name": "DescribeInteractions",
2471 "group": "Chat_Interactions",
2472 "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>",
2474 "filename": "server/api/chatInteraction/index.js",
2475 "groupTitle": "Chat_Interactions"
2479 "url": "/api/chat/interactions",
2480 "title": "Gets a list of Interactions",
2483 "title": "Example usage:",
2484 "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2488 "name": "GetInteractions",
2489 "group": "Chat_Interactions",
2490 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2492 "filename": "server/api/chatInteraction/index.js",
2493 "groupTitle": "Chat_Interactions"
2497 "url": "/api/chat/interactions/{id}/tags",
2498 "title": "Removes tags from interaction",
2501 "title": "Example usage:",
2502 "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2506 "name": "RemoveTags",
2507 "group": "Chat_Interactions",
2508 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2510 "filename": "server/api/chatInteraction/index.js",
2511 "groupTitle": "Chat_Interactions"
2515 "url": "/api/chat/interactions/{id}",
2516 "title": "Gets a single Interaction",
2519 "title": "Example usage:",
2520 "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2524 "name": "ShowInteractions",
2525 "group": "Chat_Interactions",
2526 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2528 "filename": "server/api/chatInteraction/index.js",
2529 "groupTitle": "Chat_Interactions"
2533 "url": "/api/chat/interactions/{id}/abandon",
2534 "title": "Abandon interaction",
2537 "title": "Example usage:",
2538 "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2543 "group": "Chat_Interactions",
2544 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2546 "filename": "server/api/chatInteraction/index.js",
2547 "groupTitle": "Chat_Interactions"
2551 "url": "/api/chat/interactions/{id}/close",
2552 "title": "Close Interaction",
2555 "title": "Example usage:",
2556 "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2560 "name": "addMessage",
2561 "group": "Chat_Interactions",
2562 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2564 "filename": "server/api/chatInteraction/index.js",
2565 "groupTitle": "Chat_Interactions"
2569 "url": "/api/chat/interactions/{id}/messages",
2570 "title": "Creates new messages",
2573 "title": "Example usage:",
2574 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2578 "name": "addMessage",
2579 "group": "Chat_Interactions",
2612 "field": "direction",
2626 "field": "providerName",
2633 "field": "providerResponse",
2639 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2641 "filename": "server/api/chatInteraction/index.js",
2642 "groupTitle": "Chat_Interactions"
2646 "url": "/api/chat/interactions/{id}/attachment_upload",
2647 "title": "Add attachment",
2650 "title": "Example usage:",
2651 "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",
2655 "name": "attachmentUpload",
2656 "group": "Chat_Interactions",
2657 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2659 "filename": "server/api/chatInteraction/index.js",
2660 "groupTitle": "Chat_Interactions"
2664 "url": "/api/chat/interactions/{id}/vidaoo",
2665 "title": "Create Vidaoo Session",
2668 "title": "Example usage:",
2669 "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2673 "name": "createVidaooSession",
2674 "group": "Chat_Interactions",
2675 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2677 "filename": "server/api/chatInteraction/index.js",
2678 "groupTitle": "Chat_Interactions"
2682 "url": "/api/chat/interactions/{id}/custom_update",
2683 "title": "Update interaction",
2686 "title": "Example usage:",
2687 "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",
2691 "name": "customUpdate",
2692 "group": "Chat_Interactions",
2693 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2695 "filename": "server/api/chatInteraction/index.js",
2696 "groupTitle": "Chat_Interactions"
2700 "url": "/api/chat/interactions/{id}/download",
2701 "title": "Gets interaction",
2704 "title": "Example usage:",
2705 "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2710 "group": "Chat_Interactions",
2711 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2713 "filename": "server/api/chatInteraction/index.js",
2714 "groupTitle": "Chat_Interactions"
2718 "url": "/api/chat/interactions/{id}/messages",
2719 "title": "Gets interaction messages",
2722 "title": "Example usage:",
2723 "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2727 "name": "getMessages",
2728 "group": "Chat_Interactions",
2729 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2731 "filename": "server/api/chatInteraction/index.js",
2732 "groupTitle": "Chat_Interactions"
2736 "url": "/api/chat/interactions/{id}/my_messages",
2737 "title": "Gets interaction messages",
2740 "title": "Example usage:",
2741 "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2745 "name": "getMyMessages",
2746 "group": "Chat_Interactions",
2747 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2749 "filename": "server/api/chatInteraction/index.js",
2750 "groupTitle": "Chat_Interactions"
2754 "url": "/api/chat/interactions/{id}",
2755 "title": "Update an existing Interaction",
2758 "title": "Example usage:",
2759 "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",
2763 "name": "updateInteractions",
2764 "group": "Chat_Interactions",
2765 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2767 "filename": "server/api/chatInteraction/index.js",
2768 "groupTitle": "Chat_Interactions"
2772 "url": "/api/chat/internal/messages",
2773 "title": "Creates a new Message",
2776 "title": "Example usage:",
2777 "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",
2781 "name": "CreateMessages",
2782 "group": "Chat_Internal_Messages",
2804 "field": "ChatInternalMessageId",
2810 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2812 "filename": "server/api/chatInternalMessage/index.js",
2813 "groupTitle": "Chat_Internal_Messages"
2817 "url": "/api/chat/internal/messages/{id}",
2818 "title": "Deletes a Message",
2821 "title": "Example usage:",
2822 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2826 "name": "DeleteMessages",
2827 "group": "Chat_Internal_Messages",
2828 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2830 "filename": "server/api/chatInternalMessage/index.js",
2831 "groupTitle": "Chat_Internal_Messages"
2835 "url": "/api/chat/internal/messages/describe",
2836 "title": "Gets table info about Messages",
2839 "title": "Example usage:",
2840 "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2844 "name": "DescribeMessages",
2845 "group": "Chat_Internal_Messages",
2846 "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>",
2848 "filename": "server/api/chatInternalMessage/index.js",
2849 "groupTitle": "Chat_Internal_Messages"
2853 "url": "/api/chat/internal/messages",
2854 "title": "Gets a list of Messages",
2857 "title": "Example usage:",
2858 "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2862 "name": "GetMessages",
2863 "group": "Chat_Internal_Messages",
2864 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2866 "filename": "server/api/chatInternalMessage/index.js",
2867 "groupTitle": "Chat_Internal_Messages"
2871 "url": "/api/chat/internal/messages/{id}",
2872 "title": "Gets a single Message",
2875 "title": "Example usage:",
2876 "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2880 "name": "ShowMessages",
2881 "group": "Chat_Internal_Messages",
2882 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2884 "filename": "server/api/chatInternalMessage/index.js",
2885 "groupTitle": "Chat_Internal_Messages"
2889 "url": "/api/chat/internal/messages/{id}",
2890 "title": "Update an existing Message",
2893 "title": "Example usage:",
2894 "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",
2898 "name": "updateMessages",
2899 "group": "Chat_Internal_Messages",
2900 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2902 "filename": "server/api/chatInternalMessage/index.js",
2903 "groupTitle": "Chat_Internal_Messages"
2907 "url": "/api/chat/messages",
2908 "title": "Creates a new Message",
2911 "title": "Example usage:",
2912 "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2916 "name": "CreateMessages",
2917 "group": "Chat_Messages",
2950 "field": "direction",
2964 "field": "providerName",
2971 "field": "providerResponse",
2977 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2979 "filename": "server/api/chatMessage/index.js",
2980 "groupTitle": "Chat_Messages"
2984 "url": "/api/chat/messages/{id}",
2985 "title": "Deletes a Message",
2988 "title": "Example usage:",
2989 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2993 "name": "DeleteMessages",
2994 "group": "Chat_Messages",
2995 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2997 "filename": "server/api/chatMessage/index.js",
2998 "groupTitle": "Chat_Messages"
3002 "url": "/api/chat/messages/describe",
3003 "title": "Gets table info about Messages",
3006 "title": "Example usage:",
3007 "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
3011 "name": "DescribeMessages",
3012 "group": "Chat_Messages",
3013 "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>",
3015 "filename": "server/api/chatMessage/index.js",
3016 "groupTitle": "Chat_Messages"
3020 "url": "/api/chat/messages",
3021 "title": "Gets a list of Messages",
3024 "title": "Example usage:",
3025 "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
3029 "name": "GetMessages",
3030 "group": "Chat_Messages",
3031 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3033 "filename": "server/api/chatMessage/index.js",
3034 "groupTitle": "Chat_Messages"
3038 "url": "/api/chat/messages/{id}",
3039 "title": "Gets a single Message",
3042 "title": "Example usage:",
3043 "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
3047 "name": "ShowMessages",
3048 "group": "Chat_Messages",
3049 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3051 "filename": "server/api/chatMessage/index.js",
3052 "groupTitle": "Chat_Messages"
3056 "url": "/api/chat/messages/{id}",
3057 "title": "Update an existing Message",
3060 "title": "Example usage:",
3061 "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",
3065 "name": "updateMessages",
3066 "group": "Chat_Messages",
3067 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3069 "filename": "server/api/chatMessage/index.js",
3070 "groupTitle": "Chat_Messages"
3074 "url": "/api/chat/offline_messages",
3075 "title": "Creates a new OfflineMessage",
3078 "title": "Example usage:",
3079 "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",
3083 "name": "CreateOfflineMessages",
3084 "group": "Chat_Offline_Messages",
3098 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3100 "filename": "server/api/chatOfflineMessage/index.js",
3101 "groupTitle": "Chat_Offline_Messages"
3105 "url": "/api/chat/offline_messages/{id}",
3106 "title": "Deletes a OfflineMessage",
3109 "title": "Example usage:",
3110 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
3114 "name": "DeleteOfflineMessages",
3115 "group": "Chat_Offline_Messages",
3116 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3118 "filename": "server/api/chatOfflineMessage/index.js",
3119 "groupTitle": "Chat_Offline_Messages"
3123 "url": "/api/chat/offline_messages/describe",
3124 "title": "Gets table info about OfflineMessages",
3127 "title": "Example usage:",
3128 "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
3132 "name": "DescribeOfflineMessages",
3133 "group": "Chat_Offline_Messages",
3134 "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>",
3136 "filename": "server/api/chatOfflineMessage/index.js",
3137 "groupTitle": "Chat_Offline_Messages"
3141 "url": "/api/chat/offline_messages",
3142 "title": "Gets a list of OfflineMessages",
3145 "title": "Example usage:",
3146 "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3150 "name": "GetOfflineMessages",
3151 "group": "Chat_Offline_Messages",
3152 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3154 "filename": "server/api/chatOfflineMessage/index.js",
3155 "groupTitle": "Chat_Offline_Messages"
3159 "url": "/api/chat/offline_messages/{id}",
3160 "title": "Gets a single OfflineMessage",
3163 "title": "Example usage:",
3164 "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3168 "name": "ShowOfflineMessages",
3169 "group": "Chat_Offline_Messages",
3170 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3172 "filename": "server/api/chatOfflineMessage/index.js",
3173 "groupTitle": "Chat_Offline_Messages"
3177 "url": "/api/chat/offline_messages/{id}",
3178 "title": "Update an existing OfflineMessage",
3181 "title": "Example usage:",
3182 "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",
3186 "name": "updateOfflineMessages",
3187 "group": "Chat_Offline_Messages",
3188 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3190 "filename": "server/api/chatOfflineMessage/index.js",
3191 "groupTitle": "Chat_Offline_Messages"
3195 "url": "/api/chat/proactive_actions",
3196 "title": "Creates a new Proactive Action",
3199 "title": "Example usage:",
3200 "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",
3204 "name": "CreateProactive_Actions",
3205 "group": "Chat_Proactive_Actions",
3231 "field": "selector",
3244 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3246 "filename": "server/api/chatProactiveAction/index.js",
3247 "groupTitle": "Chat_Proactive_Actions"
3251 "url": "/api/chat/proactive_actions/{id}",
3252 "title": "Deletes a Proactive Action",
3255 "title": "Example usage:",
3256 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3260 "name": "DeleteProactive_Actions",
3261 "group": "Chat_Proactive_Actions",
3262 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3264 "filename": "server/api/chatProactiveAction/index.js",
3265 "groupTitle": "Chat_Proactive_Actions"
3269 "url": "/api/chat/proactive_actions/{id}",
3270 "title": "Gets a single Proactive Action",
3273 "title": "Example usage:",
3274 "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3278 "name": "ShowProactive_Actions",
3279 "group": "Chat_Proactive_Actions",
3280 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3282 "filename": "server/api/chatProactiveAction/index.js",
3283 "groupTitle": "Chat_Proactive_Actions"
3287 "url": "/api/chat/proactive_actions/{id}",
3288 "title": "Update an existing Proactive Action",
3291 "title": "Example usage:",
3292 "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",
3296 "name": "updateProactive_Actions",
3297 "group": "Chat_Proactive_Actions",
3298 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3300 "filename": "server/api/chatProactiveAction/index.js",
3301 "groupTitle": "Chat_Proactive_Actions"
3305 "url": "/api/chat/reports/queue",
3306 "title": "Creates a new Chat Queue Report",
3309 "title": "Example usage:",
3310 "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",
3314 "name": "CreateChat_Queue_Reports",
3315 "group": "Chat_Queue_Reports",
3323 "field": "uniqueid",
3351 "field": "acceptAt",
3371 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3373 "filename": "server/api/chatQueueReport/index.js",
3374 "groupTitle": "Chat_Queue_Reports"
3378 "url": "/api/chat/reports/queue/{id}",
3379 "title": "Deletes a Chat Queue Report",
3382 "title": "Example usage:",
3383 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3387 "name": "DeleteChat_Queue_Reports",
3388 "group": "Chat_Queue_Reports",
3389 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3391 "filename": "server/api/chatQueueReport/index.js",
3392 "groupTitle": "Chat_Queue_Reports"
3396 "url": "/api/chat/reports/queue/describe",
3397 "title": "Gets table info about Chat Queue Reports",
3400 "title": "Example usage:",
3401 "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3405 "name": "DescribeChat_Queue_Reports",
3406 "group": "Chat_Queue_Reports",
3407 "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>",
3409 "filename": "server/api/chatQueueReport/index.js",
3410 "groupTitle": "Chat_Queue_Reports"
3414 "url": "/api/chat/reports/queue",
3415 "title": "Gets a list of Chat Queue Reports",
3418 "title": "Example usage:",
3419 "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3423 "name": "GetChat_Queue_Reports",
3424 "group": "Chat_Queue_Reports",
3425 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3427 "filename": "server/api/chatQueueReport/index.js",
3428 "groupTitle": "Chat_Queue_Reports"
3432 "url": "/api/chat/reports/queue/{id}",
3433 "title": "Gets a single Chat Queue Report",
3436 "title": "Example usage:",
3437 "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3441 "name": "ShowChat_Queue_Reports",
3442 "group": "Chat_Queue_Reports",
3443 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3445 "filename": "server/api/chatQueueReport/index.js",
3446 "groupTitle": "Chat_Queue_Reports"
3450 "url": "/api/chat/reports/queue/{id}",
3451 "title": "Update an existing Chat Queue Report",
3454 "title": "Example usage:",
3455 "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",
3459 "name": "updateChat_Queue_Reports",
3460 "group": "Chat_Queue_Reports",
3461 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3463 "filename": "server/api/chatQueueReport/index.js",
3464 "groupTitle": "Chat_Queue_Reports"
3468 "url": "/api/chat/queues/{id}/users",
3469 "title": "Add agents to a queue",
3472 "title": "Example usage:",
3473 "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",
3477 "name": "AddAgents",
3478 "group": "Chat_Queues",
3479 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3481 "filename": "server/api/chatQueue/index.js",
3482 "groupTitle": "Chat_Queues"
3486 "url": "/api/chat/queues/{id}/teams",
3487 "title": "Add teams to a queue",
3490 "title": "Example usage:",
3491 "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",
3496 "group": "Chat_Queues",
3497 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3499 "filename": "server/api/chatQueue/index.js",
3500 "groupTitle": "Chat_Queues"
3504 "url": "/api/chat/queues",
3505 "title": "Creates a new Queue",
3508 "title": "Example usage:",
3509 "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3513 "name": "CreateQueues",
3514 "group": "Chat_Queues",
3529 "field": "description",
3548 "field": "strategy",
3554 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3556 "filename": "server/api/chatQueue/index.js",
3557 "groupTitle": "Chat_Queues"
3561 "url": "/api/chat/queues/{id}",
3562 "title": "Deletes a Queue",
3565 "title": "Example usage:",
3566 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3570 "name": "DeleteQueues",
3571 "group": "Chat_Queues",
3572 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3574 "filename": "server/api/chatQueue/index.js",
3575 "groupTitle": "Chat_Queues"
3579 "url": "/api/chat/queues/describe",
3580 "title": "Gets table info about Queues",
3583 "title": "Example usage:",
3584 "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3588 "name": "DescribeQueues",
3589 "group": "Chat_Queues",
3590 "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>",
3592 "filename": "server/api/chatQueue/index.js",
3593 "groupTitle": "Chat_Queues"
3597 "url": "/api/chat/queues/{id}/users",
3598 "title": "Gets queue agents",
3601 "title": "Example usage:",
3602 "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3606 "name": "GetAgents",
3607 "group": "Chat_Queues",
3608 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3610 "filename": "server/api/chatQueue/index.js",
3611 "groupTitle": "Chat_Queues"
3615 "url": "/api/chat/queues/{id}/members",
3616 "title": "GetMembers",
3619 "title": "Example usage:",
3620 "content": "curl https://{domain}/api/chat/queues/{id}/members -v -u {name}:{password}",
3624 "name": "GetMembers",
3625 "group": "Chat_Queues",
3626 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3628 "filename": "server/api/chatQueue/index.js",
3629 "groupTitle": "Chat_Queues"
3633 "url": "/api/chat/queues",
3634 "title": "Gets a list of Queues",
3637 "title": "Example usage:",
3638 "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3642 "name": "GetQueues",
3643 "group": "Chat_Queues",
3644 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3646 "filename": "server/api/chatQueue/index.js",
3647 "groupTitle": "Chat_Queues"
3651 "url": "/api/chat/queues/{id}/teams",
3652 "title": "Gets queues list",
3655 "title": "Example usage:",
3656 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3661 "group": "Chat_Queues",
3662 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3664 "filename": "server/api/chatQueue/index.js",
3665 "groupTitle": "Chat_Queues"
3669 "url": "/api/chat/queues/{id}/users",
3670 "title": "Removes agents from a queue",
3673 "title": "Example usage:",
3674 "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3678 "name": "RemoveAgents",
3679 "group": "Chat_Queues",
3680 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3682 "filename": "server/api/chatQueue/index.js",
3683 "groupTitle": "Chat_Queues"
3687 "url": "/api/chat/queues/{id}",
3688 "title": "Gets a single Queue",
3691 "title": "Example usage:",
3692 "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3696 "name": "ShowQueues",
3697 "group": "Chat_Queues",
3698 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3700 "filename": "server/api/chatQueue/index.js",
3701 "groupTitle": "Chat_Queues"
3705 "url": "/api/chat/queues/{id}",
3706 "title": "Update an existing Queue",
3709 "title": "Example usage:",
3710 "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",
3714 "name": "updateQueues",
3715 "group": "Chat_Queues",
3716 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3718 "filename": "server/api/chatQueue/index.js",
3719 "groupTitle": "Chat_Queues"
3723 "url": "/api/chat/reports/transfer",
3724 "title": "Creates a new Chat Transfer Report",
3727 "title": "Example usage:",
3728 "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",
3732 "name": "CreateChat_Transfer_Reports",
3733 "group": "Chat_Transfer_Reports",
3741 "field": "uniqueid",
3760 "field": "transferredAt",
3766 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3768 "filename": "server/api/chatTransferReport/index.js",
3769 "groupTitle": "Chat_Transfer_Reports"
3773 "url": "/api/chat/reports/transfer/{id}",
3774 "title": "Deletes a Chat Transfer Report",
3777 "title": "Example usage:",
3778 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3782 "name": "DeleteChat_Transfer_Reports",
3783 "group": "Chat_Transfer_Reports",
3784 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3786 "filename": "server/api/chatTransferReport/index.js",
3787 "groupTitle": "Chat_Transfer_Reports"
3791 "url": "/api/chat/reports/transfer/describe",
3792 "title": "Gets table info about Chat Transfer Reports",
3795 "title": "Example usage:",
3796 "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3800 "name": "DescribeChat_Transfer_Reports",
3801 "group": "Chat_Transfer_Reports",
3802 "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>",
3804 "filename": "server/api/chatTransferReport/index.js",
3805 "groupTitle": "Chat_Transfer_Reports"
3809 "url": "/api/chat/reports/transfer",
3810 "title": "Gets a list of Chat Transfer Reports",
3813 "title": "Example usage:",
3814 "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3818 "name": "GetChat_Transfer_Reports",
3819 "group": "Chat_Transfer_Reports",
3820 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3822 "filename": "server/api/chatTransferReport/index.js",
3823 "groupTitle": "Chat_Transfer_Reports"
3827 "url": "/api/chat/reports/transfer/{id}",
3828 "title": "Gets a single Chat Transfer Report",
3831 "title": "Example usage:",
3832 "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3836 "name": "ShowChat_Transfer_Reports",
3837 "group": "Chat_Transfer_Reports",
3838 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3840 "filename": "server/api/chatTransferReport/index.js",
3841 "groupTitle": "Chat_Transfer_Reports"
3845 "url": "/api/chat/reports/transfer/{id}",
3846 "title": "Update an existing Chat Transfer Report",
3849 "title": "Example usage:",
3850 "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",
3854 "name": "updateChat_Transfer_Reports",
3855 "group": "Chat_Transfer_Reports",
3856 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3858 "filename": "server/api/chatTransferReport/index.js",
3859 "groupTitle": "Chat_Transfer_Reports"
3863 "url": "/api/chat/websites/{id}/users",
3864 "title": "Add agents to a website",
3867 "title": "Example usage:",
3868 "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",
3872 "name": "AddAgents",
3873 "group": "Chat_Websites",
3874 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3876 "filename": "server/api/chatWebsite/index.js",
3877 "groupTitle": "Chat_Websites"
3881 "url": "/api/chat/websites",
3882 "title": "Creates a new Website",
3885 "title": "Example usage:",
3886 "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3890 "name": "CreateWebsites",
3891 "group": "Chat_Websites",
3913 "field": "description",
3927 "field": "mapKeyOffline",
3941 "field": "agentAlias",
3948 "field": "customerAlias",
3962 "field": "color_button",
3969 "field": "textColor",
3976 "field": "fontSize",
3990 "field": "animation",
4001 "field": "header_shape",
4008 "field": "header_online",
4015 "field": "start_chat_button",
4022 "field": "offline_chat_button",
4029 "field": "header_offline",
4036 "field": "download_transcript",
4050 "field": "whiteLabel",
4057 "field": "defaultWhiteLabel",
4071 "field": "closingQuestion",
4078 "field": "formSubmitSuccessMessage",
4085 "field": "formSubmitFailureMessage",
4092 "field": "noteTitle",
4099 "field": "placeholderMessage",
4106 "field": "closingMessage",
4113 "field": "closingMessageButton",
4120 "field": "skipMessageButton",
4127 "field": "conditionAgreement",
4134 "field": "enableRating",
4141 "field": "enableFeedback",
4148 "field": "enableSendButton",
4155 "field": "feedbackTitle",
4166 "field": "ratingType",
4173 "field": "ratingStarsNumber",
4180 "field": "onlineForm",
4187 "field": "offlineForm",
4201 "field": "autoclose",
4208 "field": "enableCustomerWriting",
4215 "field": "forwardTranscript",
4222 "field": "forwardTranscriptMessage",
4229 "field": "forwardOffline",
4236 "field": "forwardOfflineAddress",
4243 "field": "waitingTitle",
4250 "field": "waitingMessage",
4257 "field": "offlineMessageSubject",
4264 "field": "offlineMessageBody",
4271 "field": "enableUnmanagedNote",
4278 "field": "unmanagedMessage",
4285 "field": "skipUnmanaged",
4292 "field": "sendUnmanaged",
4299 "field": "enableCustomerAttachment",
4306 "field": "enableCustomerCheckmarks",
4313 "field": "agentAvatar",
4320 "field": "showAgentAvatar",
4327 "field": "timezone",
4334 "field": "notificationTemplate",
4341 "field": "notificationSound",
4348 "field": "notificationShake",
4355 "field": "hideWhenOffline",
4362 "field": "agentIdentifier",
4369 "field": "waitForTheAssignedAgent",
4376 "field": "waitForTheAssignedQueue",
4383 "field": "alignment",
4390 "field": "verticalAlignment",
4397 "field": "labelText",
4404 "field": "messagesAlignment",
4411 "field": "defaultTitle",
4418 "field": "customerAvatar",
4425 "field": "showCustomerAvatar",
4432 "field": "messageFontSize",
4439 "field": "backgroundColor",
4446 "field": "queueTransfer",
4453 "field": "queueTransferTimeout",
4460 "field": "agentTransfer",
4467 "field": "agentTransferTimeout",
4474 "field": "systemAlias",
4481 "field": "systemAvatar",
4488 "field": "mandatoryDispositionPauseId",
4489 "description": "<p>Status to put when mandatory disposition is enabled</p>"
4495 "field": "mandatoryDisposition",
4496 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4502 "field": "vidaooEscalation",
4509 "field": "vidaooApiKey",
4516 "field": "vidaooTopic",
4523 "field": "vidaooNote",
4530 "field": "vidaooMetadata",
4537 "field": "openNewInteraction",
4544 "field": "subjectOffline",
4550 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4552 "filename": "server/api/chatWebsite/index.js",
4553 "groupTitle": "Chat_Websites"
4557 "url": "/api/chat/websites/{id}",
4558 "title": "Deletes a Website",
4561 "title": "Example usage:",
4562 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4566 "name": "DeleteWebsites",
4567 "group": "Chat_Websites",
4568 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4570 "filename": "server/api/chatWebsite/index.js",
4571 "groupTitle": "Chat_Websites"
4575 "url": "/api/chat/websites/describe",
4576 "title": "Gets table info about Websites",
4579 "title": "Example usage:",
4580 "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4584 "name": "DescribeWebsites",
4585 "group": "Chat_Websites",
4586 "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>",
4588 "filename": "server/api/chatWebsite/index.js",
4589 "groupTitle": "Chat_Websites"
4593 "url": "/api/chat/websites/{id}/users",
4594 "title": "Gets agents from website",
4597 "title": "Example usage:",
4598 "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4602 "name": "GetAgents",
4603 "group": "Chat_Websites",
4604 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4606 "filename": "server/api/chatWebsite/index.js",
4607 "groupTitle": "Chat_Websites"
4611 "url": "/api/chat/websites",
4612 "title": "Gets a list of Websites",
4615 "title": "Example usage:",
4616 "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4620 "name": "GetWebsites",
4621 "group": "Chat_Websites",
4622 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
4624 "filename": "server/api/chatWebsite/index.js",
4625 "groupTitle": "Chat_Websites"
4629 "url": "/api/chat/websites/{id}/users",
4630 "title": "Removes agents from a website",
4633 "title": "Example usage:",
4634 "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4638 "name": "RemoveAgents",
4639 "group": "Chat_Websites",
4640 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4642 "filename": "server/api/chatWebsite/index.js",
4643 "groupTitle": "Chat_Websites"
4647 "url": "/api/chat/websites/{id}/canned_answers",
4648 "title": "Removes canned answers from account",
4651 "title": "Example usage:",
4652 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4656 "name": "RemoveAnswers",
4657 "group": "Chat_Websites",
4658 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4660 "filename": "server/api/chatWebsite/index.js",
4661 "groupTitle": "Chat_Websites"
4665 "url": "/api/chat/websites/{id}/dispositions",
4666 "title": "Removes canned answers from account",
4669 "title": "Example usage:",
4670 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4674 "name": "RemoveDispositions",
4675 "group": "Chat_Websites",
4676 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4678 "filename": "server/api/chatWebsite/index.js",
4679 "groupTitle": "Chat_Websites"
4683 "url": "/api/chat/websites/{id}",
4684 "title": "Gets a single Website",
4687 "title": "Example usage:",
4688 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4692 "name": "ShowWebsites",
4693 "group": "Chat_Websites",
4694 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4696 "filename": "server/api/chatWebsite/index.js",
4697 "groupTitle": "Chat_Websites"
4701 "url": "/api/chat/messages/{id}/accept",
4702 "title": "Accepts message",
4705 "title": "Example usage:",
4706 "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4710 "name": "acceptMessage",
4711 "group": "Chat_Websites",
4712 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4714 "filename": "server/api/chatMessage/index.js",
4715 "groupTitle": "Chat_Websites"
4719 "url": "/api/chat/websites/{id}/canned_answers",
4720 "title": "Creates new canned answer",
4723 "title": "Example usage:",
4724 "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",
4728 "name": "addAnswer",
4729 "group": "Chat_Websites",
4751 "field": "description",
4764 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4766 "filename": "server/api/chatWebsite/index.js",
4767 "groupTitle": "Chat_Websites"
4771 "url": "/api/chat/websites/{id}/applications",
4772 "title": "Creates new applications",
4775 "title": "Example usage:",
4776 "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4780 "name": "addApplications",
4781 "group": "Chat_Websites",
4789 "field": "priority",
4810 "field": "description",
4817 "field": "interval",
4823 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4825 "filename": "server/api/chatWebsite/index.js",
4826 "groupTitle": "Chat_Websites"
4830 "url": "/api/chat/websites/{id}/avatar",
4831 "title": "Add avatar",
4834 "title": "Example usage:",
4835 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4839 "name": "addAvatar",
4840 "group": "Chat_Websites",
4841 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4843 "filename": "server/api/chatWebsite/index.js",
4844 "groupTitle": "Chat_Websites"
4848 "url": "/api/chat/websites/{id}/customer_avatar",
4849 "title": "Add customer avatar",
4852 "title": "Example usage:",
4853 "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",
4857 "name": "addCustomerAvatar",
4858 "group": "Chat_Websites",
4859 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4861 "filename": "server/api/chatWebsite/index.js",
4862 "groupTitle": "Chat_Websites"
4866 "url": "/api/chat/websites/{id}/dispositions",
4867 "title": "Creates new disposition",
4870 "title": "Example usage:",
4871 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4875 "name": "addDisposition",
4876 "group": "Chat_Websites",
4903 "field": "description",
4909 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4911 "filename": "server/api/chatWebsite/index.js",
4912 "groupTitle": "Chat_Websites"
4916 "url": "/api/chat/accounts/{id}/interactions",
4917 "title": "Creates new interactions",
4920 "title": "Example usage:",
4921 "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",
4925 "name": "addInteraction",
4926 "group": "Chat_Websites",
4941 "field": "ratingValue",
4952 "field": "ratingType",
4959 "field": "ratingMessage",
4966 "field": "pathTranscript",
4973 "field": "mailTranscript",
4980 "field": "closedAt",
4987 "field": "disposition",
4994 "field": "secondDisposition",
5001 "field": "thirdDisposition",
5015 "field": "browserName",
5022 "field": "browserVersion",
5036 "field": "osVersion",
5043 "field": "deviceModel",
5050 "field": "deviceVendor",
5057 "field": "deviceType",
5071 "field": "customerIp",
5078 "field": "formData",
5085 "field": "read1stAt",
5092 "field": "lastMsgAt",
5103 "field": "lastMsgDirection",
5110 "field": "closeReason",
5117 "field": "customerPort",
5124 "field": "vidaooSessionId",
5131 "field": "autoreplyExecuted",
5137 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5139 "filename": "server/api/chatWebsite/index.js",
5140 "groupTitle": "Chat_Websites"
5144 "url": "/api/chat/websites/{id}/logo",
5145 "title": "Add logo",
5148 "title": "Example usage:",
5149 "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
5154 "group": "Chat_Websites",
5155 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5157 "filename": "server/api/chatWebsite/index.js",
5158 "groupTitle": "Chat_Websites"
5162 "url": "/api/chat/websites/{id}/proactive_actions",
5163 "title": "Creates new Proactive Actions",
5166 "title": "Example usage:",
5167 "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",
5171 "name": "addProactiveActions",
5172 "group": "Chat_Websites",
5198 "field": "selector",
5211 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5213 "filename": "server/api/chatWebsite/index.js",
5214 "groupTitle": "Chat_Websites"
5218 "url": "/api/chat/websites/{id}/system_avatar",
5219 "title": "Add system avatar",
5222 "title": "Example usage:",
5223 "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",
5227 "name": "addSystemAvatar",
5228 "group": "Chat_Websites",
5229 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5231 "filename": "server/api/chatWebsite/index.js",
5232 "groupTitle": "Chat_Websites"
5236 "url": "/api/chat/websites/{id}/canned_answers",
5237 "title": "Gets account canned answers",
5240 "title": "Example usage:",
5241 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5245 "name": "getAnswers",
5246 "group": "Chat_Websites",
5247 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5249 "filename": "server/api/chatWebsite/index.js",
5250 "groupTitle": "Chat_Websites"
5254 "url": "/api/chat/websites/{id}/applications",
5255 "title": "Gets Website Applications",
5258 "title": "Example usage:",
5259 "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5263 "name": "getApplications",
5264 "group": "Chat_Websites",
5265 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5267 "filename": "server/api/chatWebsite/index.js",
5268 "groupTitle": "Chat_Websites"
5272 "url": "/api/chat/websites/{id}/avatar",
5273 "title": "Get avatar",
5276 "title": "Example usage:",
5277 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5281 "name": "getAvatar",
5282 "group": "Chat_Websites",
5283 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5285 "filename": "server/api/chatWebsite/index.js",
5286 "groupTitle": "Chat_Websites"
5290 "url": "/api/chat/websites/{id}/customer_avatar",
5291 "title": "Get Customer Avatar",
5294 "title": "Example usage:",
5295 "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5299 "name": "getCustomerAvatar",
5300 "group": "Chat_Websites",
5301 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5303 "filename": "server/api/chatWebsite/index.js",
5304 "groupTitle": "Chat_Websites"
5308 "url": "/api/chat/websites/{id}/dispositions",
5309 "title": "Gets account dispositions",
5312 "title": "Example usage:",
5313 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5317 "name": "getDispositions",
5318 "group": "Chat_Websites",
5319 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5321 "filename": "server/api/chatWebsite/index.js",
5322 "groupTitle": "Chat_Websites"
5326 "url": "/api/chat/websites/{id}/fields",
5327 "title": "Gets Website Fields",
5330 "title": "Example usage:",
5331 "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5335 "name": "getFields",
5336 "group": "Chat_Websites",
5337 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5339 "filename": "server/api/chatWebsite/index.js",
5340 "groupTitle": "Chat_Websites"
5344 "url": "/api/chat/websites/{id}/interactions",
5345 "title": "Gets Website Interactions",
5348 "title": "Example usage:",
5349 "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5353 "name": "getInteraction",
5354 "group": "Chat_Websites",
5355 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5357 "filename": "server/api/chatWebsite/index.js",
5358 "groupTitle": "Chat_Websites"
5362 "url": "/api/chat/websites/{id}/logo",
5363 "title": "Get logo",
5366 "title": "Example usage:",
5367 "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5372 "group": "Chat_Websites",
5373 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5375 "filename": "server/api/chatWebsite/index.js",
5376 "groupTitle": "Chat_Websites"
5380 "url": "/api/chat/websites/{id}/offline_messages",
5381 "title": "Gets Website Offline Messages",
5384 "title": "Example usage:",
5385 "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5389 "name": "getOfflineMessages",
5390 "group": "Chat_Websites",
5391 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5393 "filename": "server/api/chatWebsite/index.js",
5394 "groupTitle": "Chat_Websites"
5398 "url": "/api/chat/websites/{id}/proactive_actions",
5399 "title": "Gets Website Proactive Actions",
5402 "title": "Example usage:",
5403 "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5407 "name": "getProactiveActions",
5408 "group": "Chat_Websites",
5409 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5411 "filename": "server/api/chatWebsite/index.js",
5412 "groupTitle": "Chat_Websites"
5416 "url": "/api/chat/websites/{id}/snippet",
5417 "title": "Gets Website Snippet",
5420 "title": "Example usage:",
5421 "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5425 "name": "getSnippet",
5426 "group": "Chat_Websites",
5427 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5429 "filename": "server/api/chatWebsite/index.js",
5430 "groupTitle": "Chat_Websites"
5434 "url": "/api/chat/websites/{id}/system_avatar",
5435 "title": "Get System Avatar",
5438 "title": "Example usage:",
5439 "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5443 "name": "getSystemAvatar",
5444 "group": "Chat_Websites",
5445 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5447 "filename": "server/api/chatWebsite/index.js",
5448 "groupTitle": "Chat_Websites"
5452 "url": "/api/chat/websites/{id}/notify",
5453 "title": "Notify new message",
5456 "title": "Example usage:",
5457 "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",
5462 "group": "Chat_Websites",
5463 "description": "<p>Motion 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>",
5465 "filename": "server/api/chatWebsite/index.js",
5466 "groupTitle": "Chat_Websites"
5470 "url": "/api/chat/websites/{id}/offline",
5471 "title": "Offline message",
5474 "title": "Example usage:",
5475 "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",
5480 "group": "Chat_Websites",
5481 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5483 "filename": "server/api/chatWebsite/index.js",
5484 "groupTitle": "Chat_Websites"
5488 "url": "/api/chat/messages/{id}/reject",
5489 "title": "Rejects message",
5492 "title": "Example usage:",
5493 "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5497 "name": "rejectMessage",
5498 "group": "Chat_Websites",
5499 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5501 "filename": "server/api/chatMessage/index.js",
5502 "groupTitle": "Chat_Websites"
5506 "url": "/api/chat/websites/{id}",
5507 "title": "Update an existing Website",
5510 "title": "Example usage:",
5511 "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",
5515 "name": "updateWebsites",
5516 "group": "Chat_Websites",
5517 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5519 "filename": "server/api/chatWebsite/index.js",
5520 "groupTitle": "Chat_Websites"
5524 "url": "/api/cloudProviders",
5525 "title": "Creates a new CloudProvider",
5528 "title": "Example usage:",
5529 "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5533 "name": "CreateCloudProviders",
5534 "group": "CloudProviders",
5573 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5575 "filename": "server/api/cloudProvider/index.js",
5576 "groupTitle": "CloudProviders"
5580 "url": "/api/cloudProviders/{id}",
5581 "title": "Deletes a CloudProvider",
5584 "title": "Example usage:",
5585 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5589 "name": "DeleteCloudProviders",
5590 "group": "CloudProviders",
5591 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5593 "filename": "server/api/cloudProvider/index.js",
5594 "groupTitle": "CloudProviders"
5598 "url": "/api/cloudProviders",
5599 "title": "Gets a list of CloudProviders",
5602 "title": "Example usage:",
5603 "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5607 "name": "GetCloudProviders",
5608 "group": "CloudProviders",
5609 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5611 "filename": "server/api/cloudProvider/index.js",
5612 "groupTitle": "CloudProviders"
5616 "url": "/api/cloudProviders/oauth2/microsoft/authorize/{id}",
5617 "title": "Generates the Microsoft Identity platform authorization url",
5620 "title": "Example usage:",
5621 "content": "curl https://{domain}/api/cloudProviders/oauth2/microsoft/authorize/{id} -v -u {name}:{password}",
5625 "name": "Oauth2MicrosoftAuthorize",
5626 "group": "CloudProviders",
5627 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5629 "filename": "server/api/cloudProvider/index.js",
5630 "groupTitle": "CloudProviders"
5634 "url": "/api/cloudProviders/oauth2/microsoft/callback",
5635 "title": "Receives an authorization code from Microsoft Identity platform",
5636 "name": "Oauth2MicrosoftCallback",
5637 "group": "CloudProviders",
5638 "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>",
5640 "filename": "server/api/cloudProvider/index.js",
5641 "groupTitle": "CloudProviders"
5645 "url": "/api/cloudProviders/{id}",
5646 "title": "Gets a single CloudProvider",
5649 "title": "Example usage:",
5650 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5654 "name": "ShowCloudProviders",
5655 "group": "CloudProviders",
5656 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5658 "filename": "server/api/cloudProvider/index.js",
5659 "groupTitle": "CloudProviders"
5663 "url": "/api/cloudProviders/{id}",
5664 "title": "Update an existing CloudProvider",
5667 "title": "Example usage:",
5668 "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5672 "name": "updateCloudProviders",
5673 "group": "CloudProviders",
5674 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5676 "filename": "server/api/cloudProvider/index.js",
5677 "groupTitle": "CloudProviders"
5681 "url": "/api/cm_contact_has_items",
5682 "title": "Creates a new CmContactHasItem",
5685 "title": "Example usage:",
5686 "content": "curl https://{domain}/api/cm_contact_has_items -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5690 "name": "CreateCmContactHasItems",
5691 "group": "CmContactHasItems",
5699 "field": "CmContactId",
5713 "field": "ItemTypeId",
5720 "field": "ItemClass",
5734 "field": "description",
5740 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5742 "filename": "server/api/cmContactHasItem/index.js",
5743 "groupTitle": "CmContactHasItems"
5747 "url": "/api/cm_contact_has_items/{id}",
5748 "title": "Deletes a CmContactHasItem",
5751 "title": "Example usage:",
5752 "content": "curl https://{domain}/api/cm_contact_has_items/{id} -v -u {name}:{password} -X DELETE",
5756 "name": "DeleteCmContactHasItems",
5757 "group": "CmContactHasItems",
5758 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5760 "filename": "server/api/cmContactHasItem/index.js",
5761 "groupTitle": "CmContactHasItems"
5765 "url": "/api/cm_contact_has_items",
5766 "title": "Gets a list of CmContactHasItems",
5769 "title": "Example usage:",
5770 "content": "curl https://{domain}/api/cm_contact_has_items -v -u {name}:{password}",
5774 "name": "GetCmContactHasItems",
5775 "group": "CmContactHasItems",
5776 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm_contact_has_items?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm_contact_has_items?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm_contact_has_items?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm_contact_has_items?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm_contact_has_items?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5778 "filename": "server/api/cmContactHasItem/index.js",
5779 "groupTitle": "CmContactHasItems"
5783 "url": "/api/cm_contact_has_items/{id}",
5784 "title": "Gets a single CmContactHasItem",
5787 "title": "Example usage:",
5788 "content": "curl https://{domain}/api/cm_contact_has_items/{id} -v -u {name}:{password}",
5792 "name": "ShowCmContactHasItems",
5793 "group": "CmContactHasItems",
5794 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5796 "filename": "server/api/cmContactHasItem/index.js",
5797 "groupTitle": "CmContactHasItems"
5801 "url": "/api/cm_contact_has_items/{id}",
5802 "title": "Update an existing CmContactHasItem",
5805 "title": "Example usage:",
5806 "content": "curl https://{domain}/api/cm_contact_has_items/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5810 "name": "updateCmContactHasItems",
5811 "group": "CmContactHasItems",
5812 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5814 "filename": "server/api/cmContactHasItem/index.js",
5815 "groupTitle": "CmContactHasItems"
5819 "url": "/api/cm_hopper_additional_phones",
5820 "title": "Creates a new CmHopperAdditionalPhone",
5823 "title": "Example usage:",
5824 "content": "curl https://{domain}/api/cm_hopper_additional_phones -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5828 "name": "CreateCmHopperAdditionalPhones",
5829 "group": "CmHopperAdditionalPhones",
5837 "field": "CmHopperId",
5858 "field": "scheduledat",
5865 "field": "countbusyretry",
5872 "field": "countcongestionretry",
5879 "field": "countnoanswerretry",
5886 "field": "countnosuchnumberretry",
5893 "field": "countdropretry",
5900 "field": "countabandonedretry",
5907 "field": "countmachineretry",
5914 "field": "countagentrejectretry",
5920 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5922 "filename": "server/api/cmHopperAdditionalPhone/index.js",
5923 "groupTitle": "CmHopperAdditionalPhones"
5927 "url": "/api/cm_hopper_additional_phones/{id}",
5928 "title": "Deletes a CmHopperAdditionalPhone",
5931 "title": "Example usage:",
5932 "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -v -u {name}:{password} -X DELETE",
5936 "name": "DeleteCmHopperAdditionalPhones",
5937 "group": "CmHopperAdditionalPhones",
5938 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5940 "filename": "server/api/cmHopperAdditionalPhone/index.js",
5941 "groupTitle": "CmHopperAdditionalPhones"
5945 "url": "/api/cm_hopper_additional_phones",
5946 "title": "Gets a list of CmHopperAdditionalPhones",
5949 "title": "Example usage:",
5950 "content": "curl https://{domain}/api/cm_hopper_additional_phones -v -u {name}:{password}",
5954 "name": "GetCmHopperAdditionalPhones",
5955 "group": "CmHopperAdditionalPhones",
5956 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/cm_hopper_additional_phones?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/cm_hopper_additional_phones?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/cm_hopper_additional_phones?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/cm_hopper_additional_phones?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/cm_hopper_additional_phones?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5958 "filename": "server/api/cmHopperAdditionalPhone/index.js",
5959 "groupTitle": "CmHopperAdditionalPhones"
5963 "url": "/api/cm_hopper_additional_phones/{id}",
5964 "title": "Gets a single CmHopperAdditionalPhone",
5967 "title": "Example usage:",
5968 "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -v -u {name}:{password}",
5972 "name": "ShowCmHopperAdditionalPhones",
5973 "group": "CmHopperAdditionalPhones",
5974 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5976 "filename": "server/api/cmHopperAdditionalPhone/index.js",
5977 "groupTitle": "CmHopperAdditionalPhones"
5981 "url": "/api/cm_hopper_additional_phones/{id}",
5982 "title": "Update an existing CmHopperAdditionalPhone",
5985 "title": "Example usage:",
5986 "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5990 "name": "updateCmHopperAdditionalPhones",
5991 "group": "CmHopperAdditionalPhones",
5992 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5994 "filename": "server/api/cmHopperAdditionalPhone/index.js",
5995 "groupTitle": "CmHopperAdditionalPhones"
5999 "url": "/api/cm/companies",
6000 "title": "Creates a new Company",
6003 "title": "Example usage:",
6004 "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6008 "name": "CreateCompanies",
6009 "group": "Cm_Companies",
6031 "field": "companyId",
6073 "field": "postalCode",
6101 "field": "emailDomain",
6115 "field": "sPostalCode",
6129 "field": "sCountry",
6136 "field": "description",
6142 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6144 "filename": "server/api/cmCompany/index.js",
6145 "groupTitle": "Cm_Companies"
6149 "url": "/api/cm/companies/{id}",
6150 "title": "Deletes a Company",
6153 "title": "Example usage:",
6154 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
6158 "name": "DeleteCompanies",
6159 "group": "Cm_Companies",
6160 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6162 "filename": "server/api/cmCompany/index.js",
6163 "groupTitle": "Cm_Companies"
6167 "url": "/api/cm/companies/describe",
6168 "title": "Gets table info about Companies",
6171 "title": "Example usage:",
6172 "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
6176 "name": "DescribeCompanies",
6177 "group": "Cm_Companies",
6178 "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>",
6180 "filename": "server/api/cmCompany/index.js",
6181 "groupTitle": "Cm_Companies"
6185 "url": "/api/cm/companies",
6186 "title": "Gets a list of Companies",
6189 "title": "Example usage:",
6190 "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
6194 "name": "GetCompanies",
6195 "group": "Cm_Companies",
6196 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6198 "filename": "server/api/cmCompany/index.js",
6199 "groupTitle": "Cm_Companies"
6203 "url": "/api/cm/companies/{id}",
6204 "title": "Gets a single Company",
6207 "title": "Example usage:",
6208 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
6212 "name": "ShowCompanies",
6213 "group": "Cm_Companies",
6214 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6216 "filename": "server/api/cmCompany/index.js",
6217 "groupTitle": "Cm_Companies"
6221 "url": "/api/cm/companies/{id}/contacts",
6222 "title": "Creates new contacts",
6225 "title": "Example usage:",
6226 "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",
6230 "name": "addContacts",
6231 "group": "Cm_Companies",
6239 "field": "firstName",
6246 "field": "lastName",
6260 "field": "postalCode",
6281 "field": "dateOfBirth",
6288 "field": "description",
6330 "field": "facebook",
6386 "field": "telegram",
6400 "field": "priority",
6407 "field": "scheduledat",
6413 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6415 "filename": "server/api/cmCompany/index.js",
6416 "groupTitle": "Cm_Companies"
6420 "url": "/api/cm/companies/{id}/contacts",
6421 "title": "Gets List Contacts",
6424 "title": "Example usage:",
6425 "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
6429 "name": "getContacts",
6430 "group": "Cm_Companies",
6431 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6433 "filename": "server/api/cmCompany/index.js",
6434 "groupTitle": "Cm_Companies"
6438 "url": "/api/cm/companies/{id}",
6439 "title": "Update an existing Company",
6442 "title": "Example usage:",
6443 "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",
6447 "name": "updateCompanies",
6448 "group": "Cm_Companies",
6449 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6451 "filename": "server/api/cmCompany/index.js",
6452 "groupTitle": "Cm_Companies"
6456 "url": "/api/cm/contacts/{id}",
6457 "title": "Deletes a Contact",
6460 "title": "Example usage:",
6461 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
6465 "name": "DeleteContacts",
6466 "group": "Cm_Contacts",
6467 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6469 "filename": "server/api/cmContact/index.js",
6470 "groupTitle": "Cm_Contacts"
6474 "url": "/api/cm/contacts/describe",
6475 "title": "Gets table info about Contacts",
6478 "title": "Example usage:",
6479 "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
6483 "name": "DescribeContacts",
6484 "group": "Cm_Contacts",
6485 "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>",
6487 "filename": "server/api/cmContact/index.js",
6488 "groupTitle": "Cm_Contacts"
6492 "url": "/api/cm/contacts",
6493 "title": "Gets a list of Contacts",
6496 "title": "Example usage:",
6497 "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
6501 "name": "GetContacts",
6502 "group": "Cm_Contacts",
6503 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6505 "filename": "server/api/cmContact/index.js",
6506 "groupTitle": "Cm_Contacts"
6510 "url": "/api/cm/contacts/{id}/finals",
6511 "title": "Gets contact hopper finals",
6514 "title": "Example usage:",
6515 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password} -X GET",
6519 "name": "GetHopperFinals",
6520 "group": "Cm_Contacts",
6521 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6523 "filename": "server/api/cmContact/index.js",
6524 "groupTitle": "Cm_Contacts"
6528 "url": "/api/cm/contacts/{id}/hopper_histories",
6529 "title": "Gets contact hopper histories",
6532 "title": "Example usage:",
6533 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6537 "name": "GetHopperHistories",
6538 "group": "Cm_Contacts",
6539 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6541 "filename": "server/api/cmContact/index.js",
6542 "groupTitle": "Cm_Contacts"
6546 "url": "/api/cm/contacts/{id}/hoppers",
6547 "title": "Gets contact hoppers",
6550 "title": "Example usage:",
6551 "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6555 "name": "GetHoppers",
6556 "group": "Cm_Contacts",
6557 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6559 "filename": "server/api/cmContact/index.js",
6560 "groupTitle": "Cm_Contacts"
6564 "url": "/api/cm/contacts/create_many",
6565 "title": "Create Contacts",
6568 "title": "Example usage:",
6569 "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6573 "name": "bulkCreate",
6574 "group": "Cm_Contacts",
6575 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6577 "filename": "server/api/cmContact/index.js",
6578 "groupTitle": "Cm_Contacts"
6582 "url": "/api/cm/contacts",
6583 "title": "Create Contact",
6586 "title": "Example usage:",
6587 "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6592 "group": "Cm_Contacts",
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/cmContact/index.js",
6596 "groupTitle": "Cm_Contacts"
6600 "url": "/api/cm/contacts/{id}/duplicatePhones",
6601 "title": "Sets new contact additional phones",
6604 "title": "Example usage:",
6605 "content": "curl https://{domain}/api/cm/contacts/{id}/duplicateAdditionalPhones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6609 "name": "duplicateAdditionalPhones",
6610 "group": "Cm_Contacts",
6611 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6613 "filename": "server/api/cmContact/index.js",
6614 "groupTitle": "Cm_Contacts"
6618 "url": "/api/cm/contacts/{id}/phones",
6619 "title": "Gets contact phones",
6622 "title": "Example usage:",
6623 "content": "curl https://{domain}/api/cm/contacts/{id}/phones -v -u {name}:{password} -X GET",
6627 "name": "getAdditionalPhones",
6628 "group": "Cm_Contacts",
6629 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6631 "filename": "server/api/cmContact/index.js",
6632 "groupTitle": "Cm_Contacts"
6636 "url": "/api/cm/contacts/{id}/journey",
6637 "title": "Gets customer journey",
6640 "title": "Example usage:",
6641 "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password} -X GET",
6645 "name": "getJourney",
6646 "group": "Cm_Contacts",
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/cmContact/index.js",
6650 "groupTitle": "Cm_Contacts"
6654 "url": "/api/cm/contacts/{id}/jscripty_sessions",
6655 "title": "Gets contact hopper blacks",
6658 "title": "Example usage:",
6659 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password} -X GET",
6663 "name": "getJscriptySessions",
6664 "group": "Cm_Contacts",
6665 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/cmContact/index.js",
6668 "groupTitle": "Cm_Contacts"
6672 "url": "/api/cm/contacts/{id}/tags",
6673 "title": "Gets configurations tags",
6676 "title": "Example usage:",
6677 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6682 "group": "Cm_Contacts",
6683 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6685 "filename": "server/api/cmContact/index.js",
6686 "groupTitle": "Cm_Contacts"
6690 "url": "/api/cm/contacts/merge",
6691 "title": "Merge Contact",
6694 "title": "Example usage:",
6695 "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6700 "group": "Cm_Contacts",
6701 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6703 "filename": "server/api/cmContact/index.js",
6704 "groupTitle": "Cm_Contacts"
6708 "url": "/api/cm/contacts/{id}/rescheduleAdditionalPhones",
6709 "title": "Sets new contact additional phones",
6712 "title": "Example usage:",
6713 "content": "curl https://{domain}/api/cm/contacts/{id}/rescheduleAdditionalPhones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6717 "name": "rescheduleAdditionalPhones",
6718 "group": "Cm_Contacts",
6719 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6721 "filename": "server/api/cmContact/index.js",
6722 "groupTitle": "Cm_Contacts"
6726 "url": "/api/cm/contacts/{id}/phones",
6727 "title": "Sets new contact phones",
6730 "title": "Example usage:",
6731 "content": "curl https://{domain}/api/cm/contacts/{id}/phones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6735 "name": "setAdditionalPhones",
6736 "group": "Cm_Contacts",
6737 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6739 "filename": "server/api/cmContact/index.js",
6740 "groupTitle": "Cm_Contacts"
6744 "url": "/api/cm/contacts/{id}/tags",
6745 "title": "Sets new tags",
6748 "title": "Example usage:",
6749 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6754 "group": "Cm_Contacts",
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/cmContact/index.js",
6758 "groupTitle": "Cm_Contacts"
6762 "url": "/api/cm/contacts/{id}",
6763 "title": "Gets a single Contact",
6766 "title": "Example usage:",
6767 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6772 "group": "Cm_Contacts",
6773 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6775 "filename": "server/api/cmContact/index.js",
6776 "groupTitle": "Cm_Contacts"
6780 "url": "/api/cm/contacts/{id}",
6781 "title": "Update a single Contact",
6784 "title": "Example usage:",
6785 "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6790 "group": "Cm_Contacts",
6791 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6793 "filename": "server/api/cmContact/index.js",
6794 "groupTitle": "Cm_Contacts"
6798 "url": "/api/cm/custom_fields/{id}",
6799 "title": "Deletes a Custom Field",
6802 "title": "Example usage:",
6803 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6807 "name": "DeleteCustom_Fields",
6808 "group": "Cm_Custom_Fields",
6809 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/cmCustomField/index.js",
6812 "groupTitle": "Cm_Custom_Fields"
6816 "url": "/api/cm/custom_fields",
6817 "title": "Gets a list of Custom Fields",
6820 "title": "Example usage:",
6821 "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6825 "name": "GetCustom_Fields",
6826 "group": "Cm_Custom_Fields",
6827 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6829 "filename": "server/api/cmCustomField/index.js",
6830 "groupTitle": "Cm_Custom_Fields"
6834 "url": "/api/cm/custom_fields/{id}",
6835 "title": "Gets a single Custom Field",
6838 "title": "Example usage:",
6839 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6843 "name": "ShowCustom_Fields",
6844 "group": "Cm_Custom_Fields",
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/cmCustomField/index.js",
6848 "groupTitle": "Cm_Custom_Fields"
6852 "url": "/api/cm/custom_fields/{id}",
6853 "title": "Update an existing Custom Field",
6856 "title": "Example usage:",
6857 "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",
6861 "name": "updateCustom_Fields",
6862 "group": "Cm_Custom_Fields",
6863 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6865 "filename": "server/api/cmCustomField/index.js",
6866 "groupTitle": "Cm_Custom_Fields"
6870 "url": "/api/cm/hopper",
6871 "title": "Creates a new Hopper",
6874 "title": "Example usage:",
6875 "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6879 "name": "CreateHopper",
6880 "group": "Cm_Hopper",
6902 "field": "scheduledat",
6909 "field": "countbusyretry",
6916 "field": "countcongestionretry",
6923 "field": "countnoanswerretry",
6930 "field": "callback",
6937 "field": "callbackuniqueid",
6944 "field": "callbackat",
6951 "field": "priority",
6958 "field": "recallme",
6965 "field": "ContactId",
6986 "field": "VoiceQueueId",
6993 "field": "CampaignId",
7000 "field": "countnosuchnumberretry",
7007 "field": "countdropretry",
7014 "field": "countabandonedretry",
7021 "field": "countmachineretry",
7028 "field": "countagentrejectretry",
7042 "field": "dialTimezone",
7048 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7050 "filename": "server/api/cmHopper/index.js",
7051 "groupTitle": "Cm_Hopper"
7055 "url": "/api/cm/hopper/describe",
7056 "title": "Gets table info about Hopper",
7059 "title": "Example usage:",
7060 "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
7064 "name": "DescribeHopper",
7065 "group": "Cm_Hopper",
7066 "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>",
7068 "filename": "server/api/cmHopper/index.js",
7069 "groupTitle": "Cm_Hopper"
7073 "url": "/api/cm/hopper",
7074 "title": "Gets a list of Hopper",
7077 "title": "Example usage:",
7078 "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
7082 "name": "GetHopper",
7083 "group": "Cm_Hopper",
7084 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7086 "filename": "server/api/cmHopper/index.js",
7087 "groupTitle": "Cm_Hopper"
7091 "url": "/api/cm/hopper/{id}",
7092 "title": "Gets a single Hopper",
7095 "title": "Example usage:",
7096 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
7100 "name": "ShowHopper",
7101 "group": "Cm_Hopper",
7102 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7104 "filename": "server/api/cmHopper/index.js",
7105 "groupTitle": "Cm_Hopper"
7109 "url": "/api/cm/hopper_black/{id}",
7110 "title": "Deletes a Hopper Black",
7113 "title": "Example usage:",
7114 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
7118 "name": "DeleteHopper_Black",
7119 "group": "Cm_Hopper_Black",
7120 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7122 "filename": "server/api/cmHopperBlack/index.js",
7123 "groupTitle": "Cm_Hopper_Black"
7127 "url": "/api/cm/hopper_black/describe",
7128 "title": "Gets table info about Hopper Black",
7131 "title": "Example usage:",
7132 "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
7136 "name": "DescribeHopper_Black",
7137 "group": "Cm_Hopper_Black",
7138 "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>",
7140 "filename": "server/api/cmHopperBlack/index.js",
7141 "groupTitle": "Cm_Hopper_Black"
7145 "url": "/api/cm/hopper_black",
7146 "title": "Gets a list of Hopper Black",
7149 "title": "Example usage:",
7150 "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
7154 "name": "GetHopper_Black",
7155 "group": "Cm_Hopper_Black",
7156 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7158 "filename": "server/api/cmHopperBlack/index.js",
7159 "groupTitle": "Cm_Hopper_Black"
7163 "url": "/api/cm/hopper_black/{id}",
7164 "title": "Gets a single Hopper Black",
7167 "title": "Example usage:",
7168 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
7172 "name": "ShowHopper_Black",
7173 "group": "Cm_Hopper_Black",
7174 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7176 "filename": "server/api/cmHopperBlack/index.js",
7177 "groupTitle": "Cm_Hopper_Black"
7181 "url": "/api/cm/hopper_black/{id}",
7182 "title": "Update an existing Hopper Black",
7185 "title": "Example usage:",
7186 "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",
7190 "name": "updateHopper_Black",
7191 "group": "Cm_Hopper_Black",
7192 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7194 "filename": "server/api/cmHopperBlack/index.js",
7195 "groupTitle": "Cm_Hopper_Black"
7199 "url": "/api/cm/hopper_final/checkContactHopper",
7200 "title": "Check if contact is in hopper",
7203 "title": "Example usage:",
7204 "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",
7208 "name": "/checkContactHopper",
7209 "group": "Cm_Hopper_Final",
7210 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7212 "filename": "server/api/cmHopperFinal/index.js",
7213 "groupTitle": "Cm_Hopper_Final"
7217 "url": "/api/cm/hopper_final/describe",
7218 "title": "Gets table info about HopperFinal",
7221 "title": "Example usage:",
7222 "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
7226 "name": "DescribeHopperFinal",
7227 "group": "Cm_Hopper_Final",
7228 "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>",
7230 "filename": "server/api/cmHopperFinal/index.js",
7231 "groupTitle": "Cm_Hopper_Final"
7235 "url": "/api/cm/hopper_final",
7236 "title": "Gets a list of HopperFinal",
7239 "title": "Example usage:",
7240 "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
7244 "name": "GetHopperFinal",
7245 "group": "Cm_Hopper_Final",
7246 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7248 "filename": "server/api/cmHopperFinal/index.js",
7249 "groupTitle": "Cm_Hopper_Final"
7253 "url": "/api/cm/hopper_final/{id}",
7254 "title": "Gets a single HopperFinal",
7257 "title": "Example usage:",
7258 "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
7262 "name": "ShowHopperFinal",
7263 "group": "Cm_Hopper_Final",
7264 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7266 "filename": "server/api/cmHopperFinal/index.js",
7267 "groupTitle": "Cm_Hopper_Final"
7271 "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
7272 "title": "Return number contacts for attributes",
7275 "title": "Example usage:",
7276 "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
7280 "name": "countContactsIvrCampaignHopperFinal",
7281 "group": "Cm_Hopper_Final",
7282 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7284 "filename": "server/api/cmHopperFinal/index.js",
7285 "groupTitle": "Cm_Hopper_Final"
7289 "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
7290 "title": "Return number contacts for attributes",
7293 "title": "Example usage:",
7294 "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
7298 "name": "countContactsQueueCampaignHopperFinal",
7299 "group": "Cm_Hopper_Final",
7300 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7302 "filename": "server/api/cmHopperFinal/index.js",
7303 "groupTitle": "Cm_Hopper_Final"
7307 "url": "/api/cm/hopper_final/campaign/{id}",
7308 "title": "Move contacts in hopper",
7311 "title": "Example usage:",
7312 "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7316 "name": "moveContactsIvrCampaignHopperFinal",
7317 "group": "Cm_Hopper_Final",
7318 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7320 "filename": "server/api/cmHopperFinal/index.js",
7321 "groupTitle": "Cm_Hopper_Final"
7325 "url": "/api/cm/hopper_final/voice/queue/{id}",
7326 "title": "Move contacts in hopper",
7329 "title": "Example usage:",
7330 "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
7334 "name": "moveContactsQueueCampaignHopperFinal",
7335 "group": "Cm_Hopper_Final",
7336 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7338 "filename": "server/api/cmHopperFinal/index.js",
7339 "groupTitle": "Cm_Hopper_Final"
7343 "url": "/api/cm/hopper_final/{id}",
7344 "title": "Update a single hopper final",
7347 "title": "Example usage:",
7348 "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7353 "group": "Cm_Hopper_Final",
7354 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7356 "filename": "server/api/cmHopperFinal/index.js",
7357 "groupTitle": "Cm_Hopper_Final"
7361 "url": "/api/cm/hopper_history",
7362 "title": "Creates a new HopperHistory",
7365 "title": "Example usage:",
7366 "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",
7370 "name": "CreateHopperHistory",
7371 "group": "Cm_Hopper_History",
7386 "field": "statedesc",
7393 "field": "scheduledat",
7400 "field": "countbusyretry",
7407 "field": "countcongestionretry",
7414 "field": "countnoanswerretry",
7421 "field": "countglobal",
7428 "field": "uniqueid",
7435 "field": "originatecalleridnum",
7442 "field": "originatecalleridname",
7449 "field": "calleridnum",
7456 "field": "calleridname",
7463 "field": "starttime",
7470 "field": "responsetime",
7477 "field": "answertime",
7484 "field": "droptime",
7498 "field": "ringtime",
7505 "field": "holdtime",
7512 "field": "talktime",
7519 "field": "followuptime",
7526 "field": "dropreason",
7533 "field": "campaign",
7540 "field": "campaigntype",
7547 "field": "membername",
7575 "field": "callback",
7582 "field": "callbackuniqueid",
7589 "field": "callbackat",
7596 "field": "recallme",
7603 "field": "editedat",
7617 "field": "countnosuchnumberretry",
7624 "field": "countdropretry",
7631 "field": "countabandonedretry",
7638 "field": "countmachineretry",
7645 "field": "countagentrejectretry",
7651 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7653 "filename": "server/api/cmHopperHistory/index.js",
7654 "groupTitle": "Cm_Hopper_History"
7658 "url": "/api/cm/hopper_history/describe",
7659 "title": "Gets table info about HopperHistory",
7662 "title": "Example usage:",
7663 "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7667 "name": "DescribeHopperHistory",
7668 "group": "Cm_Hopper_History",
7669 "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>",
7671 "filename": "server/api/cmHopperHistory/index.js",
7672 "groupTitle": "Cm_Hopper_History"
7676 "url": "/api/cm/hopper_history",
7677 "title": "Gets a list of HopperHistory",
7680 "title": "Example usage:",
7681 "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7685 "name": "GetHopperHistory",
7686 "group": "Cm_Hopper_History",
7687 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7689 "filename": "server/api/cmHopperHistory/index.js",
7690 "groupTitle": "Cm_Hopper_History"
7694 "url": "/api/cm/hopper_history/{id}",
7695 "title": "Gets a single HopperHistory",
7698 "title": "Example usage:",
7699 "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7703 "name": "ShowHopperHistory",
7704 "group": "Cm_Hopper_History",
7705 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7707 "filename": "server/api/cmHopperHistory/index.js",
7708 "groupTitle": "Cm_Hopper_History"
7712 "url": "/api/cm/hopper_history/{id}",
7713 "title": "Update a single hopper history",
7716 "title": "Example usage:",
7717 "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7722 "group": "Cm_Hopper_History",
7723 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7725 "filename": "server/api/cmHopperHistory/index.js",
7726 "groupTitle": "Cm_Hopper_History"
7730 "url": "/api/cm/hopper/{id}",
7731 "title": "Delete Hopper",
7734 "title": "Example usage:",
7735 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7740 "group": "Cm_Hopper",
7741 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7743 "filename": "server/api/cmHopper/index.js",
7744 "groupTitle": "Cm_Hopper"
7748 "url": "/api/cm/hopper/opencontacts",
7749 "title": "Gets Open Contacts",
7752 "title": "Example usage:",
7753 "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7757 "name": "getOpenContacts",
7758 "group": "Cm_Hopper",
7759 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7761 "filename": "server/api/cmHopper/index.js",
7762 "groupTitle": "Cm_Hopper"
7766 "url": "/api/cm/hopper/preview",
7767 "title": "Gets Preview Dialer Contacts",
7770 "title": "Example usage:",
7771 "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7775 "name": "getPreview",
7776 "group": "Cm_Hopper",
7777 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7779 "filename": "server/api/cmHopper/index.js",
7780 "groupTitle": "Cm_Hopper"
7784 "url": "/api/cm/hopper/{id}/previewrecall",
7785 "title": "Gets Preview Dialer Contacts for Recall",
7788 "title": "Example usage:",
7789 "content": "curl https://{domain}/api/cm/hopper/{id}/previewrecall \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7793 "name": "getPreviewRecall",
7794 "group": "Cm_Hopper",
7795 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7797 "filename": "server/api/cmHopper/index.js",
7798 "groupTitle": "Cm_Hopper"
7802 "url": "/api/cm/hopper/timezones",
7803 "title": "Gets TZs list",
7806 "title": "Example usage:",
7807 "content": "curl https://{domain}/api/cm/hopper/timezones -v -u {name}:{password} -X GET",
7811 "name": "getTimezones",
7812 "group": "Cm_Hopper",
7813 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7815 "filename": "server/api/cmHopper/index.js",
7816 "groupTitle": "Cm_Hopper"
7820 "url": "/api/cm/hopper/{id}",
7821 "title": "Update an existing Hopper",
7824 "title": "Example usage:",
7825 "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",
7829 "name": "updateHopper",
7830 "group": "Cm_Hopper",
7831 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7833 "filename": "server/api/cmHopper/index.js",
7834 "groupTitle": "Cm_Hopper"
7838 "url": "/api/cm/lists",
7839 "title": "Creates a new List",
7842 "title": "Example usage:",
7843 "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7847 "name": "CreateLists",
7848 "group": "Cm_Lists",
7863 "field": "description",
7870 "field": "dialPrefix",
7876 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7878 "filename": "server/api/cmList/index.js",
7879 "groupTitle": "Cm_Lists"
7883 "url": "/api/cm/lists/{id}",
7884 "title": "Deletes a List",
7887 "title": "Example usage:",
7888 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7892 "name": "DeleteLists",
7893 "group": "Cm_Lists",
7894 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7896 "filename": "server/api/cmList/index.js",
7897 "groupTitle": "Cm_Lists"
7901 "url": "/api/cm/lists/describe",
7902 "title": "Gets table info about Lists",
7905 "title": "Example usage:",
7906 "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7910 "name": "DescribeLists",
7911 "group": "Cm_Lists",
7912 "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>",
7914 "filename": "server/api/cmList/index.js",
7915 "groupTitle": "Cm_Lists"
7919 "url": "/api/cm/lists/{id}/users",
7920 "title": "Gets agents from list",
7923 "title": "Example usage:",
7924 "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7928 "name": "GetAgents",
7929 "group": "Cm_Lists",
7930 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7932 "filename": "server/api/cmList/index.js",
7933 "groupTitle": "Cm_Lists"
7937 "url": "/api/cm/lists",
7938 "title": "Gets a list of Lists",
7941 "title": "Example usage:",
7942 "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7947 "group": "Cm_Lists",
7948 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7950 "filename": "server/api/cmList/index.js",
7951 "groupTitle": "Cm_Lists"
7955 "url": "/api/cm/lists/{id}/users",
7956 "title": "Removes agents from a list",
7959 "title": "Example usage:",
7960 "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7964 "name": "RemoveAgents",
7965 "group": "Cm_Lists",
7966 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7968 "filename": "server/api/cmList/index.js",
7969 "groupTitle": "Cm_Lists"
7973 "url": "/api/cm/lists/{id}/dispositions",
7974 "title": "Removes dispositions from account",
7977 "title": "Example usage:",
7978 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7982 "name": "RemoveDispositions",
7983 "group": "Cm_Lists",
7984 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7986 "filename": "server/api/cmList/index.js",
7987 "groupTitle": "Cm_Lists"
7991 "url": "/api/cm/lists/{id}",
7992 "title": "Gets a single List",
7995 "title": "Example usage:",
7996 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
8000 "name": "ShowLists",
8001 "group": "Cm_Lists",
8002 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8004 "filename": "server/api/cmList/index.js",
8005 "groupTitle": "Cm_Lists"
8009 "url": "/api/cm/lists/{id}/users",
8010 "title": "Adds agents to a list",
8013 "title": "Example usage:",
8014 "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",
8018 "name": "addAgents",
8019 "group": "Cm_Lists",
8020 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8022 "filename": "server/api/cmList/index.js",
8023 "groupTitle": "Cm_Lists"
8027 "url": "/api/cm/lists/{id}/contacts",
8028 "title": "Creates new contacts",
8031 "title": "Example usage:",
8032 "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",
8036 "name": "addContacts",
8037 "group": "Cm_Lists",
8045 "field": "firstName",
8052 "field": "lastName",
8066 "field": "postalCode",
8087 "field": "dateOfBirth",
8094 "field": "description",
8136 "field": "facebook",
8192 "field": "telegram",
8206 "field": "priority",
8213 "field": "scheduledat",
8219 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8221 "filename": "server/api/cmList/index.js",
8222 "groupTitle": "Cm_Lists"
8226 "url": "/api/cm/lists/{id}/fields",
8227 "title": "Creates a new custom field",
8230 "title": "Example usage:",
8231 "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8235 "name": "addCustomField",
8236 "group": "Cm_Lists",
8237 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8239 "filename": "server/api/cmList/index.js",
8240 "groupTitle": "Cm_Lists"
8244 "url": "/api/cm/lists/{id}/dispositions",
8245 "title": "Creates new disposition",
8248 "title": "Example usage:",
8249 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8253 "name": "addDisposition",
8254 "group": "Cm_Lists",
8281 "field": "description",
8287 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8289 "filename": "server/api/cmList/index.js",
8290 "groupTitle": "Cm_Lists"
8294 "url": "/api/cm/lists/{id}/contacts",
8295 "title": "Gets List Contacts",
8298 "title": "Example usage:",
8299 "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
8303 "name": "getContacts",
8304 "group": "Cm_Lists",
8305 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8307 "filename": "server/api/cmList/index.js",
8308 "groupTitle": "Cm_Lists"
8312 "url": "/api/cm/lists/{id}/fields",
8313 "title": "Gets Custom Fields",
8316 "title": "Example usage:",
8317 "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
8321 "name": "getCustomFields",
8322 "group": "Cm_Lists",
8323 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8325 "filename": "server/api/cmList/index.js",
8326 "groupTitle": "Cm_Lists"
8330 "url": "/api/cm/lists/{id}/dispositions",
8331 "title": "Gets list dispositions",
8334 "title": "Example usage:",
8335 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
8339 "name": "getDispositions",
8340 "group": "Cm_Lists",
8341 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8343 "filename": "server/api/cmList/index.js",
8344 "groupTitle": "Cm_Lists"
8348 "url": "/api/cm/lists/global_fields",
8349 "title": "Gets GLOBAL Custom Fields",
8352 "title": "Example usage:",
8353 "content": "curl https://{domain}/api/cm/lists/global_fields -v -u {name}:{password} -X GET",
8357 "name": "getGlobalCustomFields",
8358 "group": "Cm_Lists",
8359 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8361 "filename": "server/api/cmList/index.js",
8362 "groupTitle": "Cm_Lists"
8366 "url": "/api/cm/lists/{id}/contacts/csv",
8367 "title": "Gets CSV List Contacts",
8370 "title": "Example usage:",
8371 "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
8376 "group": "Cm_Lists",
8377 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8379 "filename": "server/api/cmList/index.js",
8380 "groupTitle": "Cm_Lists"
8384 "url": "/api/cm/lists/{id}",
8385 "title": "Update an existing List",
8388 "title": "Example usage:",
8389 "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",
8393 "name": "updateLists",
8394 "group": "Cm_Lists",
8395 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8397 "filename": "server/api/cmList/index.js",
8398 "groupTitle": "Cm_Lists"
8402 "url": "/api/cm/contacts/upload/:id",
8403 "title": "Import new contacts by csv",
8406 "title": "Example usage:",
8407 "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
8412 "group": "Cm_contacts",
8413 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8415 "filename": "server/api/cmContact/index.js",
8416 "groupTitle": "Cm_contacts"
8420 "url": "/api/cm/contacts/uploadUpdates/:id",
8421 "title": "Import existing contacts by csv",
8424 "title": "Example usage:",
8425 "content": "curl https://{domain}/api/cm/contacts/uploadUpdates/:id -v -u {name}:{password} -X POST",
8429 "name": "importUpdates",
8430 "group": "Cm_contacts",
8431 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8433 "filename": "server/api/cmContact/index.js",
8434 "groupTitle": "Cm_contacts"
8438 "url": "/api/cm/contacts/upload",
8439 "title": "Upload csv",
8442 "title": "Example usage:",
8443 "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
8448 "group": "Cm_contacts",
8449 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8451 "filename": "server/api/cmContact/index.js",
8452 "groupTitle": "Cm_contacts"
8456 "url": "/api/cm/contacts/csv",
8457 "title": "Create new contacts by csv",
8460 "title": "Example usage:",
8461 "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
8465 "name": "uploadCsv",
8466 "group": "Cm_contacts",
8467 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8469 "filename": "server/api/cmContact/index.js",
8470 "groupTitle": "Cm_contacts"
8474 "url": "/api/conditions/{id}",
8475 "title": "Deletes a Condition",
8478 "title": "Example usage:",
8479 "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
8483 "name": "DeleteConditions",
8484 "group": "Conditions",
8485 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8487 "filename": "server/api/condition/index.js",
8488 "groupTitle": "Conditions"
8492 "url": "/api/conditions/{id}",
8493 "title": "Update an existing Condition",
8496 "title": "Example usage:",
8497 "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8501 "name": "updateConditions",
8502 "group": "Conditions",
8503 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8505 "filename": "server/api/condition/index.js",
8506 "groupTitle": "Conditions"
8510 "url": "/api/contact_item_types",
8511 "title": "Creates a new ContactItemType",
8514 "title": "Example usage:",
8515 "content": "curl https://{domain}/api/contact_item_types -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8519 "name": "CreateContactItemTypes",
8520 "group": "ContactItemType",
8542 "field": "rgbBackgroundColor",
8548 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8550 "filename": "server/api/contactItemType/index.js",
8551 "groupTitle": "ContactItemType"
8555 "url": "/api/contact_item_types/{id}",
8556 "title": "Deletes a ContactItemType",
8559 "title": "Example usage:",
8560 "content": "curl https://{domain}/api/contact_item_types/{id} -v -u {name}:{password} -X DELETE",
8564 "name": "DeleteContactItemTypes",
8565 "group": "ContactItemType",
8566 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8568 "filename": "server/api/contactItemType/index.js",
8569 "groupTitle": "ContactItemType"
8573 "url": "/api/contact_item_types",
8574 "title": "Gets a list of ContactItemTypes",
8577 "title": "Example usage:",
8578 "content": "curl https://{domain}/api/contact_item_types -v -u {name}:{password}",
8582 "name": "GetContactItemTypes",
8583 "group": "ContactItemType",
8584 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/contact_item_types?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/contact_item_types?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/contact_item_types?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/contact_item_types?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/contact_item_types?offset=5&limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8586 "filename": "server/api/contactItemType/index.js",
8587 "groupTitle": "ContactItemType"
8591 "url": "/api/contact_item_types/{id}",
8592 "title": "Gets a single ContactItemType",
8595 "title": "Example usage:",
8596 "content": "curl https://{domain}/api/contact_item_types/{id} -v -u {name}:{password}",
8600 "name": "ShowContactItemTypes",
8601 "group": "ContactItemType",
8602 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8604 "filename": "server/api/contactItemType/index.js",
8605 "groupTitle": "ContactItemType"
8609 "url": "/api/contact_item_types/{id}",
8610 "title": "Update an existing ContactItemType",
8613 "title": "Example usage:",
8614 "content": "curl https://{domain}/api/contact_item_types/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8618 "name": "updateContactItemTypes",
8619 "group": "ContactItemType",
8620 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8622 "filename": "server/api/contactItemType/index.js",
8623 "groupTitle": "ContactItemType"
8627 "url": "/api/cm/custom_field",
8628 "title": "Create a new custom field",
8631 "title": "Example usage:",
8632 "content": "curl https://{domain}/api/cm/custom_field -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8636 "name": "CreateCustomField",
8637 "group": "Custom_Fields",
8638 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8640 "filename": "server/api/cmCustomField/index.js",
8641 "groupTitle": "Custom_Fields"
8645 "url": "/api/dashboards/items",
8646 "title": "Create dasboard item",
8649 "title": "Example usage:",
8650 "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
8655 "group": "Dashboard_Items",
8656 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8658 "filename": "server/api/dashboardItem/index.js",
8659 "groupTitle": "Dashboard_Items"
8663 "url": "/api/dashboards/items/{id}",
8664 "title": "Deletes a Dashboard Item",
8667 "title": "Example usage:",
8668 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
8672 "name": "DeleteDashboard_Items",
8673 "group": "Dashboard_Items",
8674 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8676 "filename": "server/api/dashboardItem/index.js",
8677 "groupTitle": "Dashboard_Items"
8681 "url": "/api/dashboards/items/{id}",
8682 "title": "Gets a single Dashboard Item",
8685 "title": "Example usage:",
8686 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
8690 "name": "ShowDashboard_Items",
8691 "group": "Dashboard_Items",
8692 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8694 "filename": "server/api/dashboardItem/index.js",
8695 "groupTitle": "Dashboard_Items"
8699 "url": "/api/dashboards/items/{id}",
8700 "title": "Update an existing item",
8703 "title": "Example usage:",
8704 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
8709 "group": "Dashboard_Items",
8710 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8712 "filename": "server/api/dashboardItem/index.js",
8713 "groupTitle": "Dashboard_Items"
8717 "url": "/api/dashboards/clone",
8718 "title": "Clone an existing Dashboard",
8721 "title": "Example usage:",
8722 "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8726 "name": "CloneDashboards",
8727 "group": "Dashboards",
8728 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8730 "filename": "server/api/dashboard/index.js",
8731 "groupTitle": "Dashboards"
8735 "url": "/api/dashboards",
8736 "title": "Creates a new Dashboard",
8739 "title": "Example usage:",
8740 "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8744 "name": "CreateDashboards",
8745 "group": "Dashboards",
8760 "field": "description",
8766 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8768 "filename": "server/api/dashboard/index.js",
8769 "groupTitle": "Dashboards"
8773 "url": "/api/dashboards/{id}",
8774 "title": "Deletes a Dashboard",
8777 "title": "Example usage:",
8778 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
8782 "name": "DeleteDashboards",
8783 "group": "Dashboards",
8784 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8786 "filename": "server/api/dashboard/index.js",
8787 "groupTitle": "Dashboards"
8791 "url": "/api/dashboards",
8792 "title": "Gets a list of Dashboards",
8795 "title": "Example usage:",
8796 "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8800 "name": "GetDashboards",
8801 "group": "Dashboards",
8802 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8804 "filename": "server/api/dashboard/index.js",
8805 "groupTitle": "Dashboards"
8809 "url": "/api/dashboards/{id}",
8810 "title": "Gets a single Dashboard",
8813 "title": "Example usage:",
8814 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8818 "name": "ShowDashboards",
8819 "group": "Dashboards",
8820 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8822 "filename": "server/api/dashboard/index.js",
8823 "groupTitle": "Dashboards"
8827 "url": "/api/dashboards/{id}/items",
8828 "title": "Creates new item",
8831 "title": "Example usage:",
8832 "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8837 "group": "Dashboards",
8838 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8840 "filename": "server/api/dashboard/index.js",
8841 "groupTitle": "Dashboards"
8845 "url": "/api/dashboards/{id}/items",
8846 "title": "Gets items",
8849 "title": "Example usage:",
8850 "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8855 "group": "Dashboards",
8856 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8858 "filename": "server/api/dashboard/index.js",
8859 "groupTitle": "Dashboards"
8863 "url": "/api/dashboards/{id}",
8864 "title": "Update an existing Dashboard",
8867 "title": "Example usage:",
8868 "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8872 "name": "updateDashboards",
8873 "group": "Dashboards",
8874 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8876 "filename": "server/api/dashboard/index.js",
8877 "groupTitle": "Dashboards"
8881 "url": "/api/integrations/desk/accounts",
8882 "title": "Creates a new Desk Account",
8885 "title": "Example usage:",
8886 "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",
8890 "name": "CreateDesk_Accounts",
8891 "group": "Desk_Accounts",
8906 "field": "description",
8913 "field": "username",
8920 "field": "remoteUri",
8930 "field": "authType",
8937 "field": "password",
8944 "field": "consumerKey",
8951 "field": "consumerSecret",
8965 "field": "tokenSecret",
8972 "field": "serverUrl",
8979 "\"integrationTab\"",
8989 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8991 "filename": "server/api/intDeskAccount/index.js",
8992 "groupTitle": "Desk_Accounts"
8996 "url": "/api/integrations/desk/accounts/{id}",
8997 "title": "Deletes a Desk Account",
9000 "title": "Example usage:",
9001 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
9005 "name": "DeleteDesk_Accounts",
9006 "group": "Desk_Accounts",
9007 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9009 "filename": "server/api/intDeskAccount/index.js",
9010 "groupTitle": "Desk_Accounts"
9014 "url": "/api/integrations/desk/accounts",
9015 "title": "Gets a list of Desk Accounts",
9018 "title": "Example usage:",
9019 "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
9023 "name": "GetDesk_Accounts",
9024 "group": "Desk_Accounts",
9025 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9027 "filename": "server/api/intDeskAccount/index.js",
9028 "groupTitle": "Desk_Accounts"
9032 "url": "/api/integrations/desk/accounts/{id}",
9033 "title": "Gets a single Desk Account",
9036 "title": "Example usage:",
9037 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
9041 "name": "ShowDesk_Accounts",
9042 "group": "Desk_Accounts",
9043 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9045 "filename": "server/api/intDeskAccount/index.js",
9046 "groupTitle": "Desk_Accounts"
9050 "url": "/api/integrations/desk/accounts/{id}/configurations",
9051 "title": "Creates new configuration",
9054 "title": "Example usage:",
9055 "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",
9059 "name": "addConfiguration",
9060 "group": "Desk_Accounts",
9061 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9063 "filename": "server/api/intDeskAccount/index.js",
9064 "groupTitle": "Desk_Accounts"
9068 "url": "/api/integrations/desk/accounts/{id}/configurations",
9069 "title": "Gets account configurations",
9072 "title": "Example usage:",
9073 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9077 "name": "getConfigurations",
9078 "group": "Desk_Accounts",
9079 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9081 "filename": "server/api/intDeskAccount/index.js",
9082 "groupTitle": "Desk_Accounts"
9086 "url": "/api/integrations/desk/accounts/{id}/fields",
9087 "title": "Gets account fields",
9090 "title": "Example usage:",
9091 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
9095 "name": "getFields",
9096 "group": "Desk_Accounts",
9097 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9099 "filename": "server/api/intDeskAccount/index.js",
9100 "groupTitle": "Desk_Accounts"
9104 "url": "/api/integrations/desk/accounts/{id}",
9105 "title": "Update an existing Desk Account",
9108 "title": "Example usage:",
9109 "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",
9113 "name": "updateDesk_Accounts",
9114 "group": "Desk_Accounts",
9115 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9117 "filename": "server/api/intDeskAccount/index.js",
9118 "groupTitle": "Desk_Accounts"
9122 "url": "/api/integrations/desk/configurations",
9123 "title": "Creates a new Desk Configuration",
9126 "title": "Example usage:",
9127 "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",
9131 "name": "CreateDesk_Configurations",
9132 "group": "Desk_Configurations",
9147 "field": "description",
9153 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9155 "filename": "server/api/intDeskConfiguration/index.js",
9156 "groupTitle": "Desk_Configurations"
9160 "url": "/api/integrations/desk/configurations/{id}",
9161 "title": "Deletes a Desk Configuration",
9164 "title": "Example usage:",
9165 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
9169 "name": "DeleteDesk_Configurations",
9170 "group": "Desk_Configurations",
9171 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9173 "filename": "server/api/intDeskConfiguration/index.js",
9174 "groupTitle": "Desk_Configurations"
9178 "url": "/api/integrations/desk/configurations",
9179 "title": "Gets a list of Desk Configurations",
9182 "title": "Example usage:",
9183 "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
9187 "name": "GetDesk_Configurations",
9188 "group": "Desk_Configurations",
9189 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9191 "filename": "server/api/intDeskConfiguration/index.js",
9192 "groupTitle": "Desk_Configurations"
9196 "url": "/api/integrations/desk/configurations/{id}",
9197 "title": "Gets a single Desk Configuration",
9200 "title": "Example usage:",
9201 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
9205 "name": "ShowDesk_Configurations",
9206 "group": "Desk_Configurations",
9207 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9209 "filename": "server/api/intDeskConfiguration/index.js",
9210 "groupTitle": "Desk_Configurations"
9214 "url": "/api/integrations/desk/configurations/{id}/descriptions",
9215 "title": "Gets configurations descriptions",
9218 "title": "Example usage:",
9219 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9223 "name": "getDescriptions",
9224 "group": "Desk_Configurations",
9225 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9227 "filename": "server/api/intDeskConfiguration/index.js",
9228 "groupTitle": "Desk_Configurations"
9232 "url": "/api/integrations/desk/configurations/{id}/fields",
9233 "title": "Gets configurations fields",
9236 "title": "Example usage:",
9237 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
9241 "name": "getFields",
9242 "group": "Desk_Configurations",
9243 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9245 "filename": "server/api/intDeskConfiguration/index.js",
9246 "groupTitle": "Desk_Configurations"
9250 "url": "/api/integrations/desk/configurations/{id}/subjects",
9251 "title": "Gets configurations subjects",
9254 "title": "Example usage:",
9255 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9259 "name": "getSubjects",
9260 "group": "Desk_Configurations",
9261 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9263 "filename": "server/api/intDeskConfiguration/index.js",
9264 "groupTitle": "Desk_Configurations"
9268 "url": "/api/integrations/desk/configurations/{id}/tags",
9269 "title": "Gets configurations tags",
9272 "title": "Example usage:",
9273 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
9278 "group": "Desk_Configurations",
9279 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9281 "filename": "server/api/intDeskConfiguration/index.js",
9282 "groupTitle": "Desk_Configurations"
9286 "url": "/api/integrations/desk/configurations/{id}/tags",
9287 "title": "Sets new tags",
9290 "title": "Example usage:",
9291 "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",
9296 "group": "Desk_Configurations",
9297 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9299 "filename": "server/api/intDeskConfiguration/index.js",
9300 "groupTitle": "Desk_Configurations"
9304 "url": "/api/integrations/desk/configurations/{id}",
9305 "title": "Update an existing Desk Configuration",
9308 "title": "Example usage:",
9309 "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",
9313 "name": "updateDesk_Configurations",
9314 "group": "Desk_Configurations",
9315 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9317 "filename": "server/api/intDeskConfiguration/index.js",
9318 "groupTitle": "Desk_Configurations"
9322 "url": "/api/integrations/desk/fields",
9323 "title": "Creates a new Desk Field",
9326 "title": "Example usage:",
9327 "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",
9331 "name": "CreateDesk_Fields",
9332 "group": "Desk_Fields",
9342 "\"customVariable\"",
9370 "\"customVariable\""
9380 "field": "keyContent",
9394 "field": "nameField",
9401 "field": "customField",
9408 "field": "variableName",
9414 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9416 "filename": "server/api/intDeskField/index.js",
9417 "groupTitle": "Desk_Fields"
9421 "url": "/api/integrations/desk/fields/{id}",
9422 "title": "Deletes a Desk Field",
9425 "title": "Example usage:",
9426 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
9430 "name": "DeleteDesk_Fields",
9431 "group": "Desk_Fields",
9432 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9434 "filename": "server/api/intDeskField/index.js",
9435 "groupTitle": "Desk_Fields"
9439 "url": "/api/integrations/desk/fields",
9440 "title": "Gets a list of Desk Fields",
9443 "title": "Example usage:",
9444 "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
9448 "name": "GetDesk_Fields",
9449 "group": "Desk_Fields",
9450 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9452 "filename": "server/api/intDeskField/index.js",
9453 "groupTitle": "Desk_Fields"
9457 "url": "/api/integrations/desk/fields/{id}",
9458 "title": "Gets a single Desk Field",
9461 "title": "Example usage:",
9462 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
9466 "name": "ShowDesk_Fields",
9467 "group": "Desk_Fields",
9468 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9470 "filename": "server/api/intDeskField/index.js",
9471 "groupTitle": "Desk_Fields"
9475 "url": "/api/integrations/desk/fields/{id}",
9476 "title": "Update an existing Desk Field",
9479 "title": "Example usage:",
9480 "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",
9484 "name": "updateDesk_Fields",
9485 "group": "Desk_Fields",
9486 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9488 "filename": "server/api/intDeskField/index.js",
9489 "groupTitle": "Desk_Fields"
9493 "url": "/api/dispositions",
9494 "title": "Creates a new Disposition",
9497 "title": "Example usage:",
9498 "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9502 "name": "CreateDispositions",
9503 "group": "Dispositions",
9530 "field": "description",
9536 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9538 "filename": "server/api/disposition/index.js",
9539 "groupTitle": "Dispositions"
9543 "url": "/api/dispositions/{id}",
9544 "title": "Deletes a Disposition",
9547 "title": "Example usage:",
9548 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
9552 "name": "DeleteDispositions",
9553 "group": "Dispositions",
9554 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9556 "filename": "server/api/disposition/index.js",
9557 "groupTitle": "Dispositions"
9561 "url": "/api/dispositions",
9562 "title": "Gets a list of Dispositions",
9565 "title": "Example usage:",
9566 "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
9570 "name": "GetDispositions",
9571 "group": "Dispositions",
9572 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9574 "filename": "server/api/disposition/index.js",
9575 "groupTitle": "Dispositions"
9579 "url": "/api/dispositions/{id}",
9580 "title": "Gets a single Disposition",
9583 "title": "Example usage:",
9584 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
9588 "name": "ShowDispositions",
9589 "group": "Dispositions",
9590 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9592 "filename": "server/api/disposition/index.js",
9593 "groupTitle": "Dispositions"
9597 "url": "/api/dispositions/{id}",
9598 "title": "Update an existing Disposition",
9601 "title": "Example usage:",
9602 "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9606 "name": "updateDispositions",
9607 "group": "Dispositions",
9608 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9610 "filename": "server/api/disposition/index.js",
9611 "groupTitle": "Dispositions"
9615 "url": "/api/integrations/dynamics365/accounts",
9616 "title": "Creates a new Dynamics365 Account",
9619 "title": "Example usage:",
9620 "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",
9624 "name": "CreateDynamics365_Accounts",
9625 "group": "Dynamics365_Accounts",
9640 "field": "username",
9647 "field": "password",
9654 "field": "remoteUri",
9661 "field": "tenantId",
9668 "field": "clientId",
9675 "field": "clientSecret",
9682 "field": "serverUrl",
9689 "field": "description",
9695 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9697 "filename": "server/api/intDynamics365Account/index.js",
9698 "groupTitle": "Dynamics365_Accounts"
9702 "url": "/api/integrations/dynamics365/accounts/{id}",
9703 "title": "Deletes a Dynamics365 Account",
9706 "title": "Example usage:",
9707 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
9711 "name": "DeleteDynamics365_Accounts",
9712 "group": "Dynamics365_Accounts",
9713 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9715 "filename": "server/api/intDynamics365Account/index.js",
9716 "groupTitle": "Dynamics365_Accounts"
9720 "url": "/api/integrations/dynamics365/accounts",
9721 "title": "Gets a list of Dynamics365 Accounts",
9724 "title": "Example usage:",
9725 "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
9729 "name": "GetDynamics365_Accounts",
9730 "group": "Dynamics365_Accounts",
9731 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9733 "filename": "server/api/intDynamics365Account/index.js",
9734 "groupTitle": "Dynamics365_Accounts"
9738 "url": "/api/integrations/dynamics365/accounts/{id}",
9739 "title": "Gets a single Dynamics365 Account",
9742 "title": "Example usage:",
9743 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
9747 "name": "ShowDynamics365_Accounts",
9748 "group": "Dynamics365_Accounts",
9749 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9751 "filename": "server/api/intDynamics365Account/index.js",
9752 "groupTitle": "Dynamics365_Accounts"
9756 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9757 "title": "Creates new configuration",
9760 "title": "Example usage:",
9761 "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",
9765 "name": "addConfiguration",
9766 "group": "Dynamics365_Accounts",
9767 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9769 "filename": "server/api/intDynamics365Account/index.js",
9770 "groupTitle": "Dynamics365_Accounts"
9774 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9775 "title": "Gets account configurations",
9778 "title": "Example usage:",
9779 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9783 "name": "getConfigurations",
9784 "group": "Dynamics365_Accounts",
9785 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9787 "filename": "server/api/intDynamics365Account/index.js",
9788 "groupTitle": "Dynamics365_Accounts"
9792 "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9793 "title": "Gets account fields",
9796 "title": "Example usage:",
9797 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9801 "name": "getFields",
9802 "group": "Dynamics365_Accounts",
9803 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9805 "filename": "server/api/intDynamics365Account/index.js",
9806 "groupTitle": "Dynamics365_Accounts"
9810 "url": "/api/integrations/dynamics365/accounts/{id}",
9811 "title": "Update an existing Dynamics365 Account",
9814 "title": "Example usage:",
9815 "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",
9819 "name": "updateDynamics365_Accounts",
9820 "group": "Dynamics365_Accounts",
9821 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9823 "filename": "server/api/intDynamics365Account/index.js",
9824 "groupTitle": "Dynamics365_Accounts"
9828 "url": "/api/integrations/dynamics365/configurations",
9829 "title": "Creates a new Dynamics365 Configuration",
9832 "title": "Example usage:",
9833 "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",
9837 "name": "CreateDynamics365_Configurations",
9838 "group": "Dynamics365_Configurations",
9853 "field": "description",
9864 "field": "ticketType",
9870 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9872 "filename": "server/api/intDynamics365Configuration/index.js",
9873 "groupTitle": "Dynamics365_Configurations"
9877 "url": "/api/integrations/dynamics365/configurations/{id}",
9878 "title": "Deletes a Dynamics365 Configuration",
9881 "title": "Example usage:",
9882 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9886 "name": "DeleteDynamics365_Configurations",
9887 "group": "Dynamics365_Configurations",
9888 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9890 "filename": "server/api/intDynamics365Configuration/index.js",
9891 "groupTitle": "Dynamics365_Configurations"
9895 "url": "/api/integrations/dynamics365/configurations",
9896 "title": "Gets a list of Dynamics365 Configurations",
9899 "title": "Example usage:",
9900 "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9904 "name": "GetDynamics365_Configurations",
9905 "group": "Dynamics365_Configurations",
9906 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9908 "filename": "server/api/intDynamics365Configuration/index.js",
9909 "groupTitle": "Dynamics365_Configurations"
9913 "url": "/api/integrations/dynamics365/configurations/{id}",
9914 "title": "Gets a single Dynamics365 Configuration",
9917 "title": "Example usage:",
9918 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9922 "name": "ShowDynamics365_Configurations",
9923 "group": "Dynamics365_Configurations",
9924 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9926 "filename": "server/api/intDynamics365Configuration/index.js",
9927 "groupTitle": "Dynamics365_Configurations"
9931 "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9932 "title": "Gets configurations descriptions",
9935 "title": "Example usage:",
9936 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9940 "name": "getDescriptions",
9941 "group": "Dynamics365_Configurations",
9942 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9944 "filename": "server/api/intDynamics365Configuration/index.js",
9945 "groupTitle": "Dynamics365_Configurations"
9949 "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9950 "title": "Gets configurations fields",
9953 "title": "Example usage:",
9954 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9958 "name": "getFields",
9959 "group": "Dynamics365_Configurations",
9960 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9962 "filename": "server/api/intDynamics365Configuration/index.js",
9963 "groupTitle": "Dynamics365_Configurations"
9967 "url": "/api/integrations/zoho/configurations/{id}/subjects",
9968 "title": "Gets configurations subjects",
9971 "title": "Example usage:",
9972 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9976 "name": "getSubjects",
9977 "group": "Dynamics365_Configurations",
9978 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9980 "filename": "server/api/intDynamics365Configuration/index.js",
9981 "groupTitle": "Dynamics365_Configurations"
9985 "url": "/api/integrations/dynamics365/configurations/{id}",
9986 "title": "Update an existing Dynamics365 Configuration",
9989 "title": "Example usage:",
9990 "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",
9994 "name": "updateDynamics365_Configurations",
9995 "group": "Dynamics365_Configurations",
9996 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9998 "filename": "server/api/intDynamics365Configuration/index.js",
9999 "groupTitle": "Dynamics365_Configurations"
10003 "url": "/api/integrations/dynamics365/fields",
10004 "title": "Creates a new Dynamics365 Field",
10007 "title": "Example usage:",
10008 "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",
10012 "name": "CreateDynamics365_Fields",
10013 "group": "Dynamics365_Fields",
10023 "\"customVariable\"",
10035 "field": "content",
10051 "\"customVariable\""
10054 "field": "keyType",
10061 "field": "keyContent",
10068 "field": "idField",
10075 "field": "nameField",
10082 "field": "customField",
10089 "field": "variableName",
10095 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10096 "version": "0.0.0",
10097 "filename": "server/api/intDynamics365Field/index.js",
10098 "groupTitle": "Dynamics365_Fields"
10102 "url": "/api/integrations/dynamics365/fields/{id}",
10103 "title": "Deletes a Dynamics365 Field",
10106 "title": "Example usage:",
10107 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
10111 "name": "DeleteDynamics365_Fields",
10112 "group": "Dynamics365_Fields",
10113 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10114 "version": "0.0.0",
10115 "filename": "server/api/intDynamics365Field/index.js",
10116 "groupTitle": "Dynamics365_Fields"
10120 "url": "/api/integrations/dynamics365/fields",
10121 "title": "Gets a list of Dynamics365 Fields",
10124 "title": "Example usage:",
10125 "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
10129 "name": "GetDynamics365_Fields",
10130 "group": "Dynamics365_Fields",
10131 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10132 "version": "0.0.0",
10133 "filename": "server/api/intDynamics365Field/index.js",
10134 "groupTitle": "Dynamics365_Fields"
10138 "url": "/api/integrations/dynamics365/fields/{id}",
10139 "title": "Gets a single Dynamics365 Field",
10142 "title": "Example usage:",
10143 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
10147 "name": "ShowDynamics365_Fields",
10148 "group": "Dynamics365_Fields",
10149 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10150 "version": "0.0.0",
10151 "filename": "server/api/intDynamics365Field/index.js",
10152 "groupTitle": "Dynamics365_Fields"
10156 "url": "/api/integrations/dynamics365/fields/{id}",
10157 "title": "Update an existing Dynamics365 Field",
10160 "title": "Example usage:",
10161 "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",
10165 "name": "updateDynamics365_Fields",
10166 "group": "Dynamics365_Fields",
10167 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10168 "version": "0.0.0",
10169 "filename": "server/api/intDynamics365Field/index.js",
10170 "groupTitle": "Dynamics365_Fields"
10174 "url": "/api/fax/accounts/{id}/users",
10175 "title": "Add agents to a fax account",
10178 "title": "Example usage:",
10179 "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",
10183 "name": "AddAgents",
10184 "group": "Fax_Accounts",
10185 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10186 "version": "0.0.0",
10187 "filename": "server/api/faxAccount/index.js",
10188 "groupTitle": "Fax_Accounts"
10192 "url": "/api/fax/accounts",
10193 "title": "Creates a new Account",
10196 "title": "Example usage:",
10197 "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10201 "name": "CreateAccounts",
10202 "group": "Fax_Accounts",
10217 "field": "description",
10235 "field": "headerinfo",
10242 "field": "localstationid",
10257 "field": "minrate",
10272 "field": "maxrate",
10286 "field": "gateway",
10293 "field": "faxdetect",
10300 "field": "t38timeout",
10327 "field": "notificationTemplate",
10334 "field": "notificationSound",
10341 "field": "notificationShake",
10348 "field": "waitForTheAssignedAgent",
10355 "field": "waitForTheAssignedQueue",
10362 "field": "queueTransfer",
10369 "field": "queueTransferTimeout",
10376 "field": "agentTransfer",
10383 "field": "agentTransferTimeout",
10390 "field": "mandatoryDispositionPauseId",
10391 "description": "<p>Status to put when mandatory disposition is enabled</p>"
10397 "field": "mandatoryDisposition",
10398 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
10403 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10404 "version": "0.0.0",
10405 "filename": "server/api/faxAccount/index.js",
10406 "groupTitle": "Fax_Accounts"
10410 "url": "/api/fax/accounts/{id}",
10411 "title": "Deletes a Account",
10414 "title": "Example usage:",
10415 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
10419 "name": "DeleteAccounts",
10420 "group": "Fax_Accounts",
10421 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10422 "version": "0.0.0",
10423 "filename": "server/api/faxAccount/index.js",
10424 "groupTitle": "Fax_Accounts"
10428 "url": "/api/fax/accounts/describe",
10429 "title": "Gets table info about Accounts",
10432 "title": "Example usage:",
10433 "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
10437 "name": "DescribeAccounts",
10438 "group": "Fax_Accounts",
10439 "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>",
10440 "version": "0.0.0",
10441 "filename": "server/api/faxAccount/index.js",
10442 "groupTitle": "Fax_Accounts"
10446 "url": "/api/fax/accounts",
10447 "title": "Gets a list of Accounts",
10450 "title": "Example usage:",
10451 "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
10455 "name": "GetAccounts",
10456 "group": "Fax_Accounts",
10457 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10458 "version": "0.0.0",
10459 "filename": "server/api/faxAccount/index.js",
10460 "groupTitle": "Fax_Accounts"
10464 "url": "/api/fax/accounts/{id}/users",
10465 "title": "Gets agents from fax account",
10468 "title": "Example usage:",
10469 "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
10473 "name": "GetAgents",
10474 "group": "Fax_Accounts",
10475 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10476 "version": "0.0.0",
10477 "filename": "server/api/faxAccount/index.js",
10478 "groupTitle": "Fax_Accounts"
10482 "url": "/api/fax/accounts/{id}/users",
10483 "title": "Removes agents from a fax account",
10486 "title": "Example usage:",
10487 "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10491 "name": "RemoveAgents",
10492 "group": "Fax_Accounts",
10493 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10494 "version": "0.0.0",
10495 "filename": "server/api/faxAccount/index.js",
10496 "groupTitle": "Fax_Accounts"
10500 "url": "/api/fax/accounts/{id}/canned_answers",
10501 "title": "Removes canned answers from account",
10504 "title": "Example usage:",
10505 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10509 "name": "RemoveAnswers",
10510 "group": "Fax_Accounts",
10511 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10512 "version": "0.0.0",
10513 "filename": "server/api/faxAccount/index.js",
10514 "groupTitle": "Fax_Accounts"
10518 "url": "/api/fax/accounts/{id}/dispositions",
10519 "title": "Removes dispositions from account",
10522 "title": "Example usage:",
10523 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10527 "name": "RemoveDispositions",
10528 "group": "Fax_Accounts",
10529 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10530 "version": "0.0.0",
10531 "filename": "server/api/faxAccount/index.js",
10532 "groupTitle": "Fax_Accounts"
10536 "url": "/api/fax/accounts/{id}",
10537 "title": "Gets a single Account",
10540 "title": "Example usage:",
10541 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
10545 "name": "ShowAccounts",
10546 "group": "Fax_Accounts",
10547 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10548 "version": "0.0.0",
10549 "filename": "server/api/faxAccount/index.js",
10550 "groupTitle": "Fax_Accounts"
10554 "url": "/api/fax/accounts/{id}/canned_answers",
10555 "title": "Creates new canned answer",
10558 "title": "Example usage:",
10559 "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",
10563 "name": "addAnswer",
10564 "group": "Fax_Accounts",
10586 "field": "description",
10599 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10600 "version": "0.0.0",
10601 "filename": "server/api/faxAccount/index.js",
10602 "groupTitle": "Fax_Accounts"
10606 "url": "/api/fax/accounts/{id}/applications",
10607 "title": "Creates new applications",
10610 "title": "Example usage:",
10611 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10615 "name": "addApplications",
10616 "group": "Fax_Accounts",
10624 "field": "priority",
10638 "field": "appdata",
10645 "field": "description",
10652 "field": "interval",
10658 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10659 "version": "0.0.0",
10660 "filename": "server/api/faxAccount/index.js",
10661 "groupTitle": "Fax_Accounts"
10665 "url": "/api/fax/accounts/addaccountapplications",
10666 "title": "Creates new account and applications",
10669 "title": "Example usage:",
10670 "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10674 "name": "addApplications",
10675 "group": "Fax_Accounts",
10683 "field": "priority",
10697 "field": "appdata",
10704 "field": "description",
10711 "field": "interval",
10717 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10718 "version": "0.0.0",
10719 "filename": "server/api/faxAccount/index.js",
10720 "groupTitle": "Fax_Accounts"
10724 "url": "/api/fax/accounts/{id}/dispositions",
10725 "title": "Creates new disposition",
10728 "title": "Example usage:",
10729 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10733 "name": "addDisposition",
10734 "group": "Fax_Accounts",
10761 "field": "description",
10767 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10768 "version": "0.0.0",
10769 "filename": "server/api/faxAccount/index.js",
10770 "groupTitle": "Fax_Accounts"
10774 "url": "/api/fax/accounts/{id}/interactions",
10775 "title": "Creates new interactions",
10778 "title": "Example usage:",
10779 "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",
10783 "name": "addInteraction",
10784 "group": "Fax_Accounts",
10799 "field": "closedAt",
10806 "field": "disposition",
10813 "field": "secondDisposition",
10820 "field": "thirdDisposition",
10834 "field": "read1stAt",
10852 "field": "firstMsgDirection",
10859 "field": "lastMsgAt",
10870 "field": "lastMsgDirection",
10876 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10877 "version": "0.0.0",
10878 "filename": "server/api/faxAccount/index.js",
10879 "groupTitle": "Fax_Accounts"
10883 "url": "/api/fax/accounts/{id}/canned_answers",
10884 "title": "Gets account canned answers",
10887 "title": "Example usage:",
10888 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10892 "name": "getAnswers",
10893 "group": "Fax_Accounts",
10894 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10895 "version": "0.0.0",
10896 "filename": "server/api/faxAccount/index.js",
10897 "groupTitle": "Fax_Accounts"
10901 "url": "/api/fax/accounts/{id}/applications",
10902 "title": "Gets account pplications",
10905 "title": "Example usage:",
10906 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10910 "name": "getApplications",
10911 "group": "Fax_Accounts",
10912 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10913 "version": "0.0.0",
10914 "filename": "server/api/faxAccount/index.js",
10915 "groupTitle": "Fax_Accounts"
10919 "url": "/api/fax/accounts/{id}/dispositions",
10920 "title": "Gets account dispositions",
10923 "title": "Example usage:",
10924 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10928 "name": "getDispositions",
10929 "group": "Fax_Accounts",
10930 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10931 "version": "0.0.0",
10932 "filename": "server/api/faxAccount/index.js",
10933 "groupTitle": "Fax_Accounts"
10937 "url": "/api/fax/accounts/{id}/interactions",
10938 "title": "Gets account interactions",
10941 "title": "Example usage:",
10942 "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10946 "name": "getInteraction",
10947 "group": "Fax_Accounts",
10948 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10949 "version": "0.0.0",
10950 "filename": "server/api/faxAccount/index.js",
10951 "groupTitle": "Fax_Accounts"
10955 "url": "/api/fax/accounts/{id}/messages",
10956 "title": "Gets account messages",
10959 "title": "Example usage:",
10960 "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10964 "name": "getMessages",
10965 "group": "Fax_Accounts",
10966 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10967 "version": "0.0.0",
10968 "filename": "server/api/faxAccount/index.js",
10969 "groupTitle": "Fax_Accounts"
10973 "url": "/api/fax/accounts/{id}/send",
10974 "title": "Send new fax",
10977 "title": "Example usage:",
10978 "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",
10983 "group": "Fax_Accounts",
10984 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10985 "version": "0.0.0",
10986 "filename": "server/api/faxAccount/index.js",
10987 "groupTitle": "Fax_Accounts"
10991 "url": "/api/fax/accounts/{id}",
10992 "title": "Update an existing Account",
10995 "title": "Example usage:",
10996 "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",
11000 "name": "updateAccounts",
11001 "group": "Fax_Accounts",
11002 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11003 "version": "0.0.0",
11004 "filename": "server/api/faxAccount/index.js",
11005 "groupTitle": "Fax_Accounts"
11009 "url": "/api/fax/accounts/updateaccountapplications",
11010 "title": "Update account and applications",
11013 "title": "Example usage:",
11014 "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11018 "name": "updateApplications",
11019 "group": "Fax_Accounts",
11027 "field": "priority",
11041 "field": "appdata",
11048 "field": "description",
11055 "field": "interval",
11061 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11062 "version": "0.0.0",
11063 "filename": "server/api/faxAccount/index.js",
11064 "groupTitle": "Fax_Accounts"
11068 "url": "/api/fax/applications",
11069 "title": "Creates a new Application",
11072 "title": "Example usage:",
11073 "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11077 "name": "CreateApplications",
11078 "group": "Fax_Applications",
11086 "field": "priority",
11100 "field": "appdata",
11107 "field": "description",
11114 "field": "interval",
11120 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11121 "version": "0.0.0",
11122 "filename": "server/api/faxApplication/index.js",
11123 "groupTitle": "Fax_Applications"
11127 "url": "/api/fax/applications/{id}",
11128 "title": "Deletes a Application",
11131 "title": "Example usage:",
11132 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
11136 "name": "DeleteApplications",
11137 "group": "Fax_Applications",
11138 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11139 "version": "0.0.0",
11140 "filename": "server/api/faxApplication/index.js",
11141 "groupTitle": "Fax_Applications"
11145 "url": "/api/fax/applications",
11146 "title": "Gets a list of Applications",
11149 "title": "Example usage:",
11150 "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
11154 "name": "GetApplications",
11155 "group": "Fax_Applications",
11156 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11157 "version": "0.0.0",
11158 "filename": "server/api/faxApplication/index.js",
11159 "groupTitle": "Fax_Applications"
11163 "url": "/api/fax/applications/{id}",
11164 "title": "Gets a single Application",
11167 "title": "Example usage:",
11168 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
11172 "name": "ShowApplications",
11173 "group": "Fax_Applications",
11174 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11175 "version": "0.0.0",
11176 "filename": "server/api/faxApplication/index.js",
11177 "groupTitle": "Fax_Applications"
11181 "url": "/api/fax/applications/{id}",
11182 "title": "Update an existing Application",
11185 "title": "Example usage:",
11186 "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",
11190 "name": "updateApplications",
11191 "group": "Fax_Applications",
11192 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11193 "version": "0.0.0",
11194 "filename": "server/api/faxApplication/index.js",
11195 "groupTitle": "Fax_Applications"
11199 "url": "/api/fax/interactions/{id}/tags",
11200 "title": "Add tags to the interaction",
11203 "title": "Example usage:",
11204 "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",
11209 "group": "Fax_Interactions",
11210 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11211 "version": "0.0.0",
11212 "filename": "server/api/faxInteraction/index.js",
11213 "groupTitle": "Fax_Interactions"
11217 "url": "/api/fax/interactions",
11218 "title": "Creates a new Interaction",
11221 "title": "Example usage:",
11222 "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11226 "name": "CreateInteractions",
11227 "group": "Fax_Interactions",
11242 "field": "closedAt",
11249 "field": "disposition",
11256 "field": "secondDisposition",
11263 "field": "thirdDisposition",
11277 "field": "read1stAt",
11295 "field": "firstMsgDirection",
11302 "field": "lastMsgAt",
11313 "field": "lastMsgDirection",
11319 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11320 "version": "0.0.0",
11321 "filename": "server/api/faxInteraction/index.js",
11322 "groupTitle": "Fax_Interactions"
11326 "url": "/api/fax/interactions/{id}",
11327 "title": "Deletes a Interaction",
11330 "title": "Example usage:",
11331 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
11335 "name": "DeleteInteractions",
11336 "group": "Fax_Interactions",
11337 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11338 "version": "0.0.0",
11339 "filename": "server/api/faxInteraction/index.js",
11340 "groupTitle": "Fax_Interactions"
11344 "url": "/api/fax/interactions/describe",
11345 "title": "Gets table info about Interactions",
11348 "title": "Example usage:",
11349 "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
11353 "name": "DescribeInteractions",
11354 "group": "Fax_Interactions",
11355 "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>",
11356 "version": "0.0.0",
11357 "filename": "server/api/faxInteraction/index.js",
11358 "groupTitle": "Fax_Interactions"
11362 "url": "/api/fax/interactions",
11363 "title": "Gets a list of Interactions",
11366 "title": "Example usage:",
11367 "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
11371 "name": "GetInteractions",
11372 "group": "Fax_Interactions",
11373 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11374 "version": "0.0.0",
11375 "filename": "server/api/faxInteraction/index.js",
11376 "groupTitle": "Fax_Interactions"
11380 "url": "/api/fax/interactions/{id}/tags",
11381 "title": "Removes tags from interaction",
11384 "title": "Example usage:",
11385 "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11389 "name": "RemoveTags",
11390 "group": "Fax_Interactions",
11391 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11392 "version": "0.0.0",
11393 "filename": "server/api/faxInteraction/index.js",
11394 "groupTitle": "Fax_Interactions"
11398 "url": "/api/fax/interactions/{id}",
11399 "title": "Gets a single Interaction",
11402 "title": "Example usage:",
11403 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
11407 "name": "ShowInteractions",
11408 "group": "Fax_Interactions",
11409 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11410 "version": "0.0.0",
11411 "filename": "server/api/faxInteraction/index.js",
11412 "groupTitle": "Fax_Interactions"
11416 "url": "/api/fax/interactions/{id}/messages",
11417 "title": "Creates new messages",
11420 "title": "Example usage:",
11421 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11425 "name": "addMessage",
11426 "group": "Fax_Interactions",
11452 "field": "direction",
11459 "field": "failMessage",
11472 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11473 "version": "0.0.0",
11474 "filename": "server/api/faxInteraction/index.js",
11475 "groupTitle": "Fax_Interactions"
11479 "url": "/api/fax/interactions/{id}/download",
11480 "title": "Get interactions",
11483 "title": "Example usage:",
11484 "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
11488 "name": "download",
11489 "group": "Fax_Interactions",
11490 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11491 "version": "0.0.0",
11492 "filename": "server/api/faxInteraction/index.js",
11493 "groupTitle": "Fax_Interactions"
11497 "url": "/api/fax/interactions/{id}/messages",
11498 "title": "Gets interaction messages",
11501 "title": "Example usage:",
11502 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
11506 "name": "getMessages",
11507 "group": "Fax_Interactions",
11508 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11509 "version": "0.0.0",
11510 "filename": "server/api/faxInteraction/index.js",
11511 "groupTitle": "Fax_Interactions"
11515 "url": "/api/fax/interactions/{id}",
11516 "title": "Update an existing Interaction",
11519 "title": "Example usage:",
11520 "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",
11524 "name": "updateInteractions",
11525 "group": "Fax_Interactions",
11526 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11527 "version": "0.0.0",
11528 "filename": "server/api/faxInteraction/index.js",
11529 "groupTitle": "Fax_Interactions"
11533 "url": "/api/fax/messages/{id}/download",
11534 "title": "Get message",
11537 "title": "Example usage:",
11538 "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
11542 "name": "download",
11543 "group": "Fax_Message",
11544 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11545 "version": "0.0.0",
11546 "filename": "server/api/faxMessage/index.js",
11547 "groupTitle": "Fax_Message"
11551 "url": "/api/fax/messages/{id}",
11552 "title": "Deletes a Message",
11555 "title": "Example usage:",
11556 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
11560 "name": "DeleteMessages",
11561 "group": "Fax_Messages",
11562 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11563 "version": "0.0.0",
11564 "filename": "server/api/faxMessage/index.js",
11565 "groupTitle": "Fax_Messages"
11569 "url": "/api/fax/messages/describe",
11570 "title": "Gets table info about Messages",
11573 "title": "Example usage:",
11574 "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
11578 "name": "DescribeMessages",
11579 "group": "Fax_Messages",
11580 "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>",
11581 "version": "0.0.0",
11582 "filename": "server/api/faxMessage/index.js",
11583 "groupTitle": "Fax_Messages"
11587 "url": "/api/fax/messages",
11588 "title": "Gets a list of Messages",
11591 "title": "Example usage:",
11592 "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
11596 "name": "GetMessages",
11597 "group": "Fax_Messages",
11598 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11599 "version": "0.0.0",
11600 "filename": "server/api/faxMessage/index.js",
11601 "groupTitle": "Fax_Messages"
11605 "url": "/api/fax/messages/{id}",
11606 "title": "Gets a single Message",
11609 "title": "Example usage:",
11610 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
11614 "name": "ShowMessages",
11615 "group": "Fax_Messages",
11616 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11617 "version": "0.0.0",
11618 "filename": "server/api/faxMessage/index.js",
11619 "groupTitle": "Fax_Messages"
11623 "url": "/api/fax/messages/{id}/accept",
11624 "title": "Accepts message",
11627 "title": "Example usage:",
11628 "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11632 "name": "acceptMessage",
11633 "group": "Fax_Messages",
11634 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11635 "version": "0.0.0",
11636 "filename": "server/api/faxMessage/index.js",
11637 "groupTitle": "Fax_Messages"
11641 "url": "/api/fax/messages/{id}/reject",
11642 "title": "Rejects message",
11645 "title": "Example usage:",
11646 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11650 "name": "rejectMessage",
11651 "group": "Fax_Messages",
11652 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11653 "version": "0.0.0",
11654 "filename": "server/api/faxMessage/index.js",
11655 "groupTitle": "Fax_Messages"
11659 "url": "/api/fax/messages",
11660 "title": "Create message and send Fax",
11663 "title": "Example usage:",
11664 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11668 "name": "rejectMessage",
11669 "group": "Fax_Messages",
11670 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11671 "version": "0.0.0",
11672 "filename": "server/api/faxMessage/index.js",
11673 "groupTitle": "Fax_Messages"
11677 "url": "/api/fax/messages/{id}",
11678 "title": "Update an existing Message",
11681 "title": "Example usage:",
11682 "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",
11686 "name": "updateMessages",
11687 "group": "Fax_Messages",
11688 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11689 "version": "0.0.0",
11690 "filename": "server/api/faxMessage/index.js",
11691 "groupTitle": "Fax_Messages"
11695 "url": "/api/fax/reports/queue",
11696 "title": "Creates a new Fax Queue Report",
11699 "title": "Example usage:",
11700 "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",
11704 "name": "CreateFax_Queue_Reports",
11705 "group": "Fax_Queue_Reports",
11713 "field": "uniqueid",
11734 "field": "leaveAt",
11741 "field": "acceptAt",
11761 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11762 "version": "0.0.0",
11763 "filename": "server/api/faxQueueReport/index.js",
11764 "groupTitle": "Fax_Queue_Reports"
11768 "url": "/api/fax/reports/queue/{id}",
11769 "title": "Deletes a Fax Queue Report",
11772 "title": "Example usage:",
11773 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
11777 "name": "DeleteFax_Queue_Reports",
11778 "group": "Fax_Queue_Reports",
11779 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11780 "version": "0.0.0",
11781 "filename": "server/api/faxQueueReport/index.js",
11782 "groupTitle": "Fax_Queue_Reports"
11786 "url": "/api/fax/reports/queue/describe",
11787 "title": "Gets table info about Fax Queue Reports",
11790 "title": "Example usage:",
11791 "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11795 "name": "DescribeFax_Queue_Reports",
11796 "group": "Fax_Queue_Reports",
11797 "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>",
11798 "version": "0.0.0",
11799 "filename": "server/api/faxQueueReport/index.js",
11800 "groupTitle": "Fax_Queue_Reports"
11804 "url": "/api/fax/reports/queue",
11805 "title": "Gets a list of Fax Queue Reports",
11808 "title": "Example usage:",
11809 "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11813 "name": "GetFax_Queue_Reports",
11814 "group": "Fax_Queue_Reports",
11815 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11816 "version": "0.0.0",
11817 "filename": "server/api/faxQueueReport/index.js",
11818 "groupTitle": "Fax_Queue_Reports"
11822 "url": "/api/fax/reports/queue/{id}",
11823 "title": "Gets a single Fax Queue Report",
11826 "title": "Example usage:",
11827 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11831 "name": "ShowFax_Queue_Reports",
11832 "group": "Fax_Queue_Reports",
11833 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11834 "version": "0.0.0",
11835 "filename": "server/api/faxQueueReport/index.js",
11836 "groupTitle": "Fax_Queue_Reports"
11840 "url": "/api/fax/reports/queue/{id}",
11841 "title": "Update an existing Fax Queue Report",
11844 "title": "Example usage:",
11845 "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",
11849 "name": "updateFax_Queue_Reports",
11850 "group": "Fax_Queue_Reports",
11851 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11852 "version": "0.0.0",
11853 "filename": "server/api/faxQueueReport/index.js",
11854 "groupTitle": "Fax_Queue_Reports"
11858 "url": "/api/fax/queues/{id}/users",
11859 "title": "Add agents to a queue",
11862 "title": "Example usage:",
11863 "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",
11867 "name": "AddAgents",
11868 "group": "Fax_Queues",
11869 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11870 "version": "0.0.0",
11871 "filename": "server/api/faxQueue/index.js",
11872 "groupTitle": "Fax_Queues"
11876 "url": "/api/fax/queues/{id}/teams",
11877 "title": "Add teams to a queue",
11880 "title": "Example usage:",
11881 "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",
11885 "name": "AddTeams",
11886 "group": "Fax_Queues",
11887 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11888 "version": "0.0.0",
11889 "filename": "server/api/faxQueue/index.js",
11890 "groupTitle": "Fax_Queues"
11894 "url": "/api/fax/queues",
11895 "title": "Creates a new Queue",
11898 "title": "Example usage:",
11899 "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11903 "name": "CreateQueues",
11904 "group": "Fax_Queues",
11919 "field": "description",
11926 "field": "timeout",
11938 "field": "strategy",
11945 "field": "lastAgent",
11951 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11952 "version": "0.0.0",
11953 "filename": "server/api/faxQueue/index.js",
11954 "groupTitle": "Fax_Queues"
11958 "url": "/api/fax/queues/{id}",
11959 "title": "Deletes a Queue",
11962 "title": "Example usage:",
11963 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11967 "name": "DeleteQueues",
11968 "group": "Fax_Queues",
11969 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11970 "version": "0.0.0",
11971 "filename": "server/api/faxQueue/index.js",
11972 "groupTitle": "Fax_Queues"
11976 "url": "/api/fax/queues/describe",
11977 "title": "Gets table info about Queues",
11980 "title": "Example usage:",
11981 "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11985 "name": "DescribeQueues",
11986 "group": "Fax_Queues",
11987 "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>",
11988 "version": "0.0.0",
11989 "filename": "server/api/faxQueue/index.js",
11990 "groupTitle": "Fax_Queues"
11994 "url": "/api/fax/queues/{id}/users",
11995 "title": "Gets queue agents",
11998 "title": "Example usage:",
11999 "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
12003 "name": "GetAgents",
12004 "group": "Fax_Queues",
12005 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12006 "version": "0.0.0",
12007 "filename": "server/api/faxQueue/index.js",
12008 "groupTitle": "Fax_Queues"
12012 "url": "/api/fax/queues/{id}/members",
12013 "title": "GetMembers",
12016 "title": "Example usage:",
12017 "content": "curl https://{domain}/api/fax/queues/{id}/members -v -u {name}:{password}",
12021 "name": "GetMembers",
12022 "group": "Fax_Queues",
12023 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12024 "version": "0.0.0",
12025 "filename": "server/api/faxQueue/index.js",
12026 "groupTitle": "Fax_Queues"
12030 "url": "/api/fax/queues",
12031 "title": "Gets a list of Queues",
12034 "title": "Example usage:",
12035 "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
12039 "name": "GetQueues",
12040 "group": "Fax_Queues",
12041 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12042 "version": "0.0.0",
12043 "filename": "server/api/faxQueue/index.js",
12044 "groupTitle": "Fax_Queues"
12048 "url": "/api/fax/queues/{id}/teams",
12049 "title": "Gets queues list",
12052 "title": "Example usage:",
12053 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
12057 "name": "GetTeams",
12058 "group": "Fax_Queues",
12059 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12060 "version": "0.0.0",
12061 "filename": "server/api/faxQueue/index.js",
12062 "groupTitle": "Fax_Queues"
12066 "url": "/api/fax/queues/{id}/users",
12067 "title": "Removes agents from a queue",
12070 "title": "Example usage:",
12071 "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
12075 "name": "RemoveAgents",
12076 "group": "Fax_Queues",
12077 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12078 "version": "0.0.0",
12079 "filename": "server/api/faxQueue/index.js",
12080 "groupTitle": "Fax_Queues"
12084 "url": "/api/fax/queues/{id}",
12085 "title": "Gets a single Queue",
12088 "title": "Example usage:",
12089 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
12093 "name": "ShowQueues",
12094 "group": "Fax_Queues",
12095 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12096 "version": "0.0.0",
12097 "filename": "server/api/faxQueue/index.js",
12098 "groupTitle": "Fax_Queues"
12102 "url": "/api/fax/queues/{id}",
12103 "title": "Update an existing Queue",
12106 "title": "Example usage:",
12107 "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",
12111 "name": "updateQueues",
12112 "group": "Fax_Queues",
12113 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12114 "version": "0.0.0",
12115 "filename": "server/api/faxQueue/index.js",
12116 "groupTitle": "Fax_Queues"
12120 "url": "/api/fax/reports/transfer",
12121 "title": "Creates a new Fax Transfer Report",
12124 "title": "Example usage:",
12125 "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",
12129 "name": "CreateFax_Transfer_Reports",
12130 "group": "Fax_Transfer_Reports",
12138 "field": "uniqueid",
12157 "field": "transferredAt",
12163 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12164 "version": "0.0.0",
12165 "filename": "server/api/faxTransferReport/index.js",
12166 "groupTitle": "Fax_Transfer_Reports"
12170 "url": "/api/fax/reports/transfer/{id}",
12171 "title": "Deletes a Fax Transfer Report",
12174 "title": "Example usage:",
12175 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
12179 "name": "DeleteFax_Transfer_Reports",
12180 "group": "Fax_Transfer_Reports",
12181 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12182 "version": "0.0.0",
12183 "filename": "server/api/faxTransferReport/index.js",
12184 "groupTitle": "Fax_Transfer_Reports"
12188 "url": "/api/fax/reports/transfer/describe",
12189 "title": "Gets table info about Fax Transfer Reports",
12192 "title": "Example usage:",
12193 "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
12197 "name": "DescribeFax_Transfer_Reports",
12198 "group": "Fax_Transfer_Reports",
12199 "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>",
12200 "version": "0.0.0",
12201 "filename": "server/api/faxTransferReport/index.js",
12202 "groupTitle": "Fax_Transfer_Reports"
12206 "url": "/api/fax/reports/transfer",
12207 "title": "Gets a list of Fax Transfer Reports",
12210 "title": "Example usage:",
12211 "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
12215 "name": "GetFax_Transfer_Reports",
12216 "group": "Fax_Transfer_Reports",
12217 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12218 "version": "0.0.0",
12219 "filename": "server/api/faxTransferReport/index.js",
12220 "groupTitle": "Fax_Transfer_Reports"
12224 "url": "/api/fax/reports/transfer/{id}",
12225 "title": "Gets a single Fax Transfer Report",
12228 "title": "Example usage:",
12229 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
12233 "name": "ShowFax_Transfer_Reports",
12234 "group": "Fax_Transfer_Reports",
12235 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12236 "version": "0.0.0",
12237 "filename": "server/api/faxTransferReport/index.js",
12238 "groupTitle": "Fax_Transfer_Reports"
12242 "url": "/api/fax/reports/transfer/{id}",
12243 "title": "Update an existing Fax Transfer Report",
12246 "title": "Example usage:",
12247 "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",
12251 "name": "updateFax_Transfer_Reports",
12252 "group": "Fax_Transfer_Reports",
12253 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12254 "version": "0.0.0",
12255 "filename": "server/api/faxTransferReport/index.js",
12256 "groupTitle": "Fax_Transfer_Reports"
12260 "url": "/api/integrations/freshdesk/accounts",
12261 "title": "Creates a new Freshdesk Account",
12264 "title": "Example usage:",
12265 "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",
12269 "name": "CreateFreshdesk_Accounts",
12270 "group": "Freshdesk_Accounts",
12285 "field": "description",
12292 "field": "username",
12306 "field": "remoteUri",
12313 "field": "serverUrl",
12319 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12320 "version": "0.0.0",
12321 "filename": "server/api/intFreshdeskAccount/index.js",
12322 "groupTitle": "Freshdesk_Accounts"
12326 "url": "/api/integrations/freshdesk/accounts/{id}",
12327 "title": "Deletes a Freshdesk Account",
12330 "title": "Example usage:",
12331 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
12335 "name": "DeleteFreshdesk_Accounts",
12336 "group": "Freshdesk_Accounts",
12337 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12338 "version": "0.0.0",
12339 "filename": "server/api/intFreshdeskAccount/index.js",
12340 "groupTitle": "Freshdesk_Accounts"
12344 "url": "/api/integrations/freshdesk/accounts",
12345 "title": "Gets a list of Freshdesk Accounts",
12348 "title": "Example usage:",
12349 "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
12353 "name": "GetFreshdesk_Accounts",
12354 "group": "Freshdesk_Accounts",
12355 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12356 "version": "0.0.0",
12357 "filename": "server/api/intFreshdeskAccount/index.js",
12358 "groupTitle": "Freshdesk_Accounts"
12362 "url": "/api/integrations/freshdesk/accounts/{id}",
12363 "title": "Gets a single Freshdesk Account",
12366 "title": "Example usage:",
12367 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
12371 "name": "ShowFreshdesk_Accounts",
12372 "group": "Freshdesk_Accounts",
12373 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12374 "version": "0.0.0",
12375 "filename": "server/api/intFreshdeskAccount/index.js",
12376 "groupTitle": "Freshdesk_Accounts"
12380 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
12381 "title": "Creates new configuration",
12384 "title": "Example usage:",
12385 "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",
12389 "name": "addConfiguration",
12390 "group": "Freshdesk_Accounts",
12391 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12392 "version": "0.0.0",
12393 "filename": "server/api/intFreshdeskAccount/index.js",
12394 "groupTitle": "Freshdesk_Accounts"
12398 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
12399 "title": "Gets account configurations",
12402 "title": "Example usage:",
12403 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12407 "name": "getConfigurations",
12408 "group": "Freshdesk_Accounts",
12409 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12410 "version": "0.0.0",
12411 "filename": "server/api/intFreshdeskAccount/index.js",
12412 "groupTitle": "Freshdesk_Accounts"
12416 "url": "/api/integrations/freshdesk/accounts/{id}/fields",
12417 "title": "Gets account fields",
12420 "title": "Example usage:",
12421 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
12425 "name": "getFields",
12426 "group": "Freshdesk_Accounts",
12427 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12428 "version": "0.0.0",
12429 "filename": "server/api/intFreshdeskAccount/index.js",
12430 "groupTitle": "Freshdesk_Accounts"
12434 "url": "/api/integrations/freshdesk/accounts/{id}",
12435 "title": "Update an existing Freshdesk Account",
12438 "title": "Example usage:",
12439 "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",
12443 "name": "updateFreshdesk_Accounts",
12444 "group": "Freshdesk_Accounts",
12445 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12446 "version": "0.0.0",
12447 "filename": "server/api/intFreshdeskAccount/index.js",
12448 "groupTitle": "Freshdesk_Accounts"
12452 "url": "/api/integrations/freshdesk/configurations",
12453 "title": "Creates a new Freshdesk Configuration",
12456 "title": "Example usage:",
12457 "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",
12461 "name": "CreateFreshdesk_Configurations",
12462 "group": "Freshdesk_Configurations",
12477 "field": "description",
12483 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12484 "version": "0.0.0",
12485 "filename": "server/api/intFreshdeskConfiguration/index.js",
12486 "groupTitle": "Freshdesk_Configurations"
12490 "url": "/api/integrations/freshdesk/configurations/{id}",
12491 "title": "Deletes a Freshdesk Configuration",
12494 "title": "Example usage:",
12495 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
12499 "name": "DeleteFreshdesk_Configurations",
12500 "group": "Freshdesk_Configurations",
12501 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12502 "version": "0.0.0",
12503 "filename": "server/api/intFreshdeskConfiguration/index.js",
12504 "groupTitle": "Freshdesk_Configurations"
12508 "url": "/api/integrations/freshdesk/configurations",
12509 "title": "Gets a list of Freshdesk Configurations",
12512 "title": "Example usage:",
12513 "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
12517 "name": "GetFreshdesk_Configurations",
12518 "group": "Freshdesk_Configurations",
12519 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12520 "version": "0.0.0",
12521 "filename": "server/api/intFreshdeskConfiguration/index.js",
12522 "groupTitle": "Freshdesk_Configurations"
12526 "url": "/api/integrations/freshdesk/configurations/{id}",
12527 "title": "Gets a single Freshdesk Configuration",
12530 "title": "Example usage:",
12531 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
12535 "name": "ShowFreshdesk_Configurations",
12536 "group": "Freshdesk_Configurations",
12537 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12538 "version": "0.0.0",
12539 "filename": "server/api/intFreshdeskConfiguration/index.js",
12540 "groupTitle": "Freshdesk_Configurations"
12544 "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
12545 "title": "Gets configurations descriptions",
12548 "title": "Example usage:",
12549 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12553 "name": "getDescriptions",
12554 "group": "Freshdesk_Configurations",
12555 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12556 "version": "0.0.0",
12557 "filename": "server/api/intFreshdeskConfiguration/index.js",
12558 "groupTitle": "Freshdesk_Configurations"
12562 "url": "/api/integrations/freshdesk/configurations/{id}/fields",
12563 "title": "Gets configurations fields",
12566 "title": "Example usage:",
12567 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
12571 "name": "getFields",
12572 "group": "Freshdesk_Configurations",
12573 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12574 "version": "0.0.0",
12575 "filename": "server/api/intFreshdeskConfiguration/index.js",
12576 "groupTitle": "Freshdesk_Configurations"
12580 "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
12581 "title": "Gets configurations subjects",
12584 "title": "Example usage:",
12585 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12589 "name": "getSubjects",
12590 "group": "Freshdesk_Configurations",
12591 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12592 "version": "0.0.0",
12593 "filename": "server/api/intFreshdeskConfiguration/index.js",
12594 "groupTitle": "Freshdesk_Configurations"
12598 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
12599 "title": "Gets configurations tags",
12602 "title": "Example usage:",
12603 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
12608 "group": "Freshdesk_Configurations",
12609 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12610 "version": "0.0.0",
12611 "filename": "server/api/intFreshdeskConfiguration/index.js",
12612 "groupTitle": "Freshdesk_Configurations"
12616 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
12617 "title": "Sets new tags",
12620 "title": "Example usage:",
12621 "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",
12626 "group": "Freshdesk_Configurations",
12627 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12628 "version": "0.0.0",
12629 "filename": "server/api/intFreshdeskConfiguration/index.js",
12630 "groupTitle": "Freshdesk_Configurations"
12634 "url": "/api/integrations/freshdesk/configurations/{id}",
12635 "title": "Update an existing Freshdesk Configuration",
12638 "title": "Example usage:",
12639 "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",
12643 "name": "updateFreshdesk_Configurations",
12644 "group": "Freshdesk_Configurations",
12645 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12646 "version": "0.0.0",
12647 "filename": "server/api/intFreshdeskConfiguration/index.js",
12648 "groupTitle": "Freshdesk_Configurations"
12652 "url": "/api/integrations/freshdesk/fields",
12653 "title": "Creates a new Freshdesk Field",
12656 "title": "Example usage:",
12657 "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",
12661 "name": "CreateFreshdesk_Fields",
12662 "group": "Freshdesk_Fields",
12672 "\"customVariable\"",
12684 "field": "content",
12700 "\"customVariable\""
12703 "field": "keyType",
12710 "field": "keyContent",
12717 "field": "idField",
12724 "field": "nameField",
12731 "field": "customField",
12738 "field": "variableName",
12744 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12745 "version": "0.0.0",
12746 "filename": "server/api/intFreshdeskField/index.js",
12747 "groupTitle": "Freshdesk_Fields"
12751 "url": "/api/integrations/freshdesk/fields/{id}",
12752 "title": "Deletes a Freshdesk Field",
12755 "title": "Example usage:",
12756 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
12760 "name": "DeleteFreshdesk_Fields",
12761 "group": "Freshdesk_Fields",
12762 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12763 "version": "0.0.0",
12764 "filename": "server/api/intFreshdeskField/index.js",
12765 "groupTitle": "Freshdesk_Fields"
12769 "url": "/api/integrations/freshdesk/fields",
12770 "title": "Gets a list of Freshdesk Fields",
12773 "title": "Example usage:",
12774 "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
12778 "name": "GetFreshdesk_Fields",
12779 "group": "Freshdesk_Fields",
12780 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12781 "version": "0.0.0",
12782 "filename": "server/api/intFreshdeskField/index.js",
12783 "groupTitle": "Freshdesk_Fields"
12787 "url": "/api/integrations/freshdesk/fields/{id}",
12788 "title": "Gets a single Freshdesk Field",
12791 "title": "Example usage:",
12792 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
12796 "name": "ShowFreshdesk_Fields",
12797 "group": "Freshdesk_Fields",
12798 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12799 "version": "0.0.0",
12800 "filename": "server/api/intFreshdeskField/index.js",
12801 "groupTitle": "Freshdesk_Fields"
12805 "url": "/api/integrations/freshdesk/fields/{id}",
12806 "title": "Update an existing Freshdesk Field",
12809 "title": "Example usage:",
12810 "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",
12814 "name": "updateFreshdesk_Fields",
12815 "group": "Freshdesk_Fields",
12816 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12817 "version": "0.0.0",
12818 "filename": "server/api/intFreshdeskField/index.js",
12819 "groupTitle": "Freshdesk_Fields"
12823 "url": "/api/integrations/freshsales/accounts",
12824 "title": "Creates a new Freshsales Account",
12827 "title": "Example usage:",
12828 "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",
12832 "name": "CreateFreshsales_Accounts",
12833 "group": "Freshsales_Accounts",
12848 "field": "description",
12855 "field": "username",
12869 "field": "remoteUri",
12876 "field": "serverUrl",
12882 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12883 "version": "0.0.0",
12884 "filename": "server/api/intFreshsalesAccount/index.js",
12885 "groupTitle": "Freshsales_Accounts"
12889 "url": "/api/integrations/freshsales/accounts/{id}",
12890 "title": "Deletes a Freshsales Account",
12893 "title": "Example usage:",
12894 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12898 "name": "DeleteFreshsales_Accounts",
12899 "group": "Freshsales_Accounts",
12900 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12901 "version": "0.0.0",
12902 "filename": "server/api/intFreshsalesAccount/index.js",
12903 "groupTitle": "Freshsales_Accounts"
12907 "url": "/api/integrations/freshsales/accounts",
12908 "title": "Gets a list of Freshsales Accounts",
12911 "title": "Example usage:",
12912 "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12916 "name": "GetFreshsales_Accounts",
12917 "group": "Freshsales_Accounts",
12918 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12919 "version": "0.0.0",
12920 "filename": "server/api/intFreshsalesAccount/index.js",
12921 "groupTitle": "Freshsales_Accounts"
12925 "url": "/api/integrations/freshsales/accounts/{id}",
12926 "title": "Gets a single Freshsales Account",
12929 "title": "Example usage:",
12930 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12934 "name": "ShowFreshsales_Accounts",
12935 "group": "Freshsales_Accounts",
12936 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12937 "version": "0.0.0",
12938 "filename": "server/api/intFreshsalesAccount/index.js",
12939 "groupTitle": "Freshsales_Accounts"
12943 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12944 "title": "Creates new configuration",
12947 "title": "Example usage:",
12948 "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",
12952 "name": "addConfiguration",
12953 "group": "Freshsales_Accounts",
12954 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12955 "version": "0.0.0",
12956 "filename": "server/api/intFreshsalesAccount/index.js",
12957 "groupTitle": "Freshsales_Accounts"
12961 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12962 "title": "Gets account configurations",
12965 "title": "Example usage:",
12966 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12970 "name": "getConfigurations",
12971 "group": "Freshsales_Accounts",
12972 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12973 "version": "0.0.0",
12974 "filename": "server/api/intFreshsalesAccount/index.js",
12975 "groupTitle": "Freshsales_Accounts"
12979 "url": "/api/integrations/freshsales/accounts/{id}/fields",
12980 "title": "Gets account fields",
12983 "title": "Example usage:",
12984 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12988 "name": "getFields",
12989 "group": "Freshsales_Accounts",
12990 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12991 "version": "0.0.0",
12992 "filename": "server/api/intFreshsalesAccount/index.js",
12993 "groupTitle": "Freshsales_Accounts"
12997 "url": "/api/integrations/freshsales/accounts/{id}",
12998 "title": "Update an existing Freshsales Account",
13001 "title": "Example usage:",
13002 "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",
13006 "name": "updateFreshsales_Accounts",
13007 "group": "Freshsales_Accounts",
13008 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13009 "version": "0.0.0",
13010 "filename": "server/api/intFreshsalesAccount/index.js",
13011 "groupTitle": "Freshsales_Accounts"
13015 "url": "/api/integrations/freshsales/configurations",
13016 "title": "Creates a new Freshsales Configuration",
13019 "title": "Example usage:",
13020 "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",
13024 "name": "CreateFreshsales_Configurations",
13025 "group": "Freshsales_Configurations",
13040 "field": "description",
13046 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13047 "version": "0.0.0",
13048 "filename": "server/api/intFreshsalesConfiguration/index.js",
13049 "groupTitle": "Freshsales_Configurations"
13053 "url": "/api/integrations/freshsales/configurations/{id}",
13054 "title": "Deletes a Freshsales Configuration",
13057 "title": "Example usage:",
13058 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
13062 "name": "DeleteFreshsales_Configurations",
13063 "group": "Freshsales_Configurations",
13064 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13065 "version": "0.0.0",
13066 "filename": "server/api/intFreshsalesConfiguration/index.js",
13067 "groupTitle": "Freshsales_Configurations"
13071 "url": "/api/integrations/freshsales/configurations",
13072 "title": "Gets a list of Freshsales Configurations",
13075 "title": "Example usage:",
13076 "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
13080 "name": "GetFreshsales_Configurations",
13081 "group": "Freshsales_Configurations",
13082 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13083 "version": "0.0.0",
13084 "filename": "server/api/intFreshsalesConfiguration/index.js",
13085 "groupTitle": "Freshsales_Configurations"
13089 "url": "/api/integrations/freshsales/configurations/{id}",
13090 "title": "Gets a single Freshsales Configuration",
13093 "title": "Example usage:",
13094 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
13098 "name": "ShowFreshsales_Configurations",
13099 "group": "Freshsales_Configurations",
13100 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13101 "version": "0.0.0",
13102 "filename": "server/api/intFreshsalesConfiguration/index.js",
13103 "groupTitle": "Freshsales_Configurations"
13107 "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
13108 "title": "Gets configurations descriptions",
13111 "title": "Example usage:",
13112 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
13116 "name": "getDescriptions",
13117 "group": "Freshsales_Configurations",
13118 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13119 "version": "0.0.0",
13120 "filename": "server/api/intFreshsalesConfiguration/index.js",
13121 "groupTitle": "Freshsales_Configurations"
13125 "url": "/api/integrations/freshsales/configurations/{id}/fields",
13126 "title": "Gets configurations fields",
13129 "title": "Example usage:",
13130 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
13134 "name": "getFields",
13135 "group": "Freshsales_Configurations",
13136 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13137 "version": "0.0.0",
13138 "filename": "server/api/intFreshsalesConfiguration/index.js",
13139 "groupTitle": "Freshsales_Configurations"
13143 "url": "/api/integrations/freshsales/configurations/{id}/subjects",
13144 "title": "Gets configurations subjects",
13147 "title": "Example usage:",
13148 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
13152 "name": "getSubjects",
13153 "group": "Freshsales_Configurations",
13154 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13155 "version": "0.0.0",
13156 "filename": "server/api/intFreshsalesConfiguration/index.js",
13157 "groupTitle": "Freshsales_Configurations"
13161 "url": "/api/integrations/freshsales/configurations/{id}",
13162 "title": "Update an existing Freshsales Configuration",
13165 "title": "Example usage:",
13166 "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",
13170 "name": "updateFreshsales_Configurations",
13171 "group": "Freshsales_Configurations",
13172 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13173 "version": "0.0.0",
13174 "filename": "server/api/intFreshsalesConfiguration/index.js",
13175 "groupTitle": "Freshsales_Configurations"
13179 "url": "/api/integrations/freshsales/fields",
13180 "title": "Creates a new Freshsales Field",
13183 "title": "Example usage:",
13184 "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",
13188 "name": "CreateFreshsales_Fields",
13189 "group": "Freshsales_Fields",
13199 "\"customVariable\"",
13211 "field": "content",
13227 "\"customVariable\""
13230 "field": "keyType",
13237 "field": "keyContent",
13244 "field": "idField",
13251 "field": "nameField",
13258 "field": "customField",
13265 "field": "variableName",
13271 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13272 "version": "0.0.0",
13273 "filename": "server/api/intFreshsalesField/index.js",
13274 "groupTitle": "Freshsales_Fields"
13278 "url": "/api/integrations/freshsales/fields/{id}",
13279 "title": "Deletes a Freshsales Field",
13282 "title": "Example usage:",
13283 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
13287 "name": "DeleteFreshsales_Fields",
13288 "group": "Freshsales_Fields",
13289 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13290 "version": "0.0.0",
13291 "filename": "server/api/intFreshsalesField/index.js",
13292 "groupTitle": "Freshsales_Fields"
13296 "url": "/api/integrations/freshsales/fields",
13297 "title": "Gets a list of Freshsales Fields",
13300 "title": "Example usage:",
13301 "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
13305 "name": "GetFreshsales_Fields",
13306 "group": "Freshsales_Fields",
13307 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13308 "version": "0.0.0",
13309 "filename": "server/api/intFreshsalesField/index.js",
13310 "groupTitle": "Freshsales_Fields"
13314 "url": "/api/integrations/freshsales/fields/{id}",
13315 "title": "Gets a single Freshsales Field",
13318 "title": "Example usage:",
13319 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
13323 "name": "ShowFreshsales_Fields",
13324 "group": "Freshsales_Fields",
13325 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13326 "version": "0.0.0",
13327 "filename": "server/api/intFreshsalesField/index.js",
13328 "groupTitle": "Freshsales_Fields"
13332 "url": "/api/integrations/freshsales/fields/{id}",
13333 "title": "Update an existing Freshsales Field",
13336 "title": "Example usage:",
13337 "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",
13341 "name": "updateFreshsales_Fields",
13342 "group": "Freshsales_Fields",
13343 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13344 "version": "0.0.0",
13345 "filename": "server/api/intFreshsalesField/index.js",
13346 "groupTitle": "Freshsales_Fields"
13350 "url": "/api/campaigns/{id}/blacklists",
13351 "title": "Add blacklists to an IVR campaign",
13354 "title": "Example usage:",
13355 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13359 "name": "AddBlackLists",
13360 "group": "IVR_Campaigns",
13361 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13362 "version": "0.0.0",
13363 "filename": "server/api/campaign/index.js",
13364 "groupTitle": "IVR_Campaigns"
13368 "url": "/api/campaigns/{id}/lists",
13369 "title": "Add lists to an IVR campaign",
13372 "title": "Example usage:",
13373 "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13377 "name": "AddLists",
13378 "group": "IVR_Campaigns",
13379 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13380 "version": "0.0.0",
13381 "filename": "server/api/campaign/index.js",
13382 "groupTitle": "IVR_Campaigns"
13386 "url": "/api/campaigns/clone",
13387 "title": "Clone an existing IVR Campaign",
13390 "title": "Example usage:",
13391 "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13395 "name": "CloneIVR_Campaigns",
13396 "group": "IVR_Campaigns",
13397 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13398 "version": "0.0.0",
13399 "filename": "server/api/campaign/index.js",
13400 "groupTitle": "IVR_Campaigns"
13404 "url": "/api/campaigns",
13405 "title": "Creates a new IVR Campaign",
13408 "title": "Example usage:",
13409 "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13413 "name": "CreateIVR_Campaigns",
13414 "group": "IVR_Campaigns",
13439 "field": "description",
13447 "description": "<p>Active/Disactive Campaign</p>"
13453 "field": "limitCalls",
13454 "description": "<p>Max 200 calls.</p>"
13460 "field": "dialOriginateCallerIdName",
13467 "field": "dialOriginateCallerIdNumber",
13474 "field": "dialOriginateTimeout",
13475 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
13481 "field": "dialCongestionMaxRetry",
13482 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
13488 "field": "dialCongestionRetryFrequency",
13489 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
13495 "field": "dialBusyMaxRetry",
13496 "description": "<p>#Busy Retry (min:1, max:999)</p>"
13502 "field": "dialBusyRetryFrequency",
13503 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
13509 "field": "dialNoAnswerMaxRetry",
13510 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
13516 "field": "dialNoAnswerRetryFrequency",
13517 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
13523 "field": "dialGlobalMaxRetry",
13524 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
13530 "field": "dialTimezone",
13537 "field": "dialGlobalInterval",
13549 "field": "dialCheckDuplicateType",
13556 "field": "dialAMDActive",
13557 "description": "<p>Active/Disactive AMD</p>"
13563 "field": "dialAMDInitialSilence",
13564 "description": "<p>#AMD Initial Silence</p>"
13570 "field": "dialAMDGreeting",
13571 "description": "<p>#AMD Greeting</p>"
13577 "field": "dialAMDAfterGreetingSilence",
13578 "description": "<p>#AMD After Greeting Silence</p>"
13584 "field": "dialAMDTotalAnalysisTime",
13585 "description": "<p>#AMD Total Analysis Time</p>"
13591 "field": "dialAMDMinWordLength",
13592 "description": "<p>#AMD Min Word Length</p>"
13598 "field": "dialAMDBetweenWordsSilence",
13599 "description": "<p>#AMD Between Words Silence</p>"
13605 "field": "dialAMDMaximumNumberOfWords",
13606 "description": "<p>#AMD Maximum Number Of Words</p>"
13612 "field": "dialAMDSilenceThreshold",
13613 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
13619 "field": "dialAMDMaximumWordLength",
13620 "description": "<p>#AMD Maximum Word Length</p>"
13630 "field": "dialOrderByScheduledAt",
13637 "field": "dialPrefix",
13644 "field": "dialRandomLastDigitCallerIdNumber",
13645 "description": "<p>Random Last Digit (min:1, max:15)</p>"
13651 "field": "dialCutDigit",
13652 "description": "<p>Cut Digit (min:1, max:15)</p>"
13658 "field": "dialNoSuchNumberMaxRetry",
13659 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
13665 "field": "dialNoSuchNumberRetryFrequency",
13666 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
13672 "field": "dialDropMaxRetry",
13673 "description": "<p>#Drop Retry (min:1, max:999)</p>"
13679 "field": "dialDropRetryFrequency",
13680 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
13686 "field": "dialAbandonedMaxRetry",
13687 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
13693 "field": "dialAbandonedRetryFrequency",
13694 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
13700 "field": "dialMachineMaxRetry",
13701 "description": "<p>#Machine Retry (min:1, max:999)</p>"
13707 "field": "dialMachineRetryFrequency",
13708 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
13714 "field": "dialAgentRejectMaxRetry",
13715 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
13721 "field": "dialAgentRejectRetryFrequency",
13722 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
13727 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13728 "version": "0.0.0",
13729 "filename": "server/api/campaign/index.js",
13730 "groupTitle": "IVR_Campaigns"
13734 "url": "/api/campaigns/{id}",
13735 "title": "Deletes a IVR Campaign",
13738 "title": "Example usage:",
13739 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
13743 "name": "DeleteIVR_Campaigns",
13744 "group": "IVR_Campaigns",
13745 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13746 "version": "0.0.0",
13747 "filename": "server/api/campaign/index.js",
13748 "groupTitle": "IVR_Campaigns"
13752 "url": "/api/campaigns/{id}/blacklists",
13753 "title": "Get IVR campaign blacklists",
13756 "title": "Example usage:",
13757 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
13761 "name": "GetBlackLists",
13762 "group": "IVR_Campaigns",
13763 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13764 "version": "0.0.0",
13765 "filename": "server/api/campaign/index.js",
13766 "groupTitle": "IVR_Campaigns"
13770 "url": "/api/campaigns/{id}/finals",
13771 "title": "Gets IVR campaign hopper finals",
13774 "title": "Example usage:",
13775 "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password} -X GET",
13779 "name": "GetHopperFinals",
13780 "group": "IVR_Campaigns",
13781 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13782 "version": "0.0.0",
13783 "filename": "server/api/campaign/index.js",
13784 "groupTitle": "IVR_Campaigns"
13788 "url": "/api/campaigns/{id}/hopper_histories",
13789 "title": "Gets IVR campaign hopper histories",
13792 "title": "Example usage:",
13793 "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
13797 "name": "GetHopperHistories",
13798 "group": "IVR_Campaigns",
13799 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13800 "version": "0.0.0",
13801 "filename": "server/api/campaign/index.js",
13802 "groupTitle": "IVR_Campaigns"
13806 "url": "/api/campaigns/{id}/hoppers",
13807 "title": "Gets IVR campaign hoppers",
13810 "title": "Example usage:",
13811 "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13815 "name": "GetHoppers",
13816 "group": "IVR_Campaigns",
13817 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/campaign/index.js",
13820 "groupTitle": "IVR_Campaigns"
13824 "url": "/api/campaigns",
13825 "title": "Gets a list of IVR Campaigns",
13828 "title": "Example usage:",
13829 "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13833 "name": "GetIVR_Campaigns",
13834 "group": "IVR_Campaigns",
13835 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13836 "version": "0.0.0",
13837 "filename": "server/api/campaign/index.js",
13838 "groupTitle": "IVR_Campaigns"
13842 "url": "/api/campaigns/{id}/lists",
13843 "title": "Get IVR campaign lists",
13846 "title": "Example usage:",
13847 "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13851 "name": "GetLists",
13852 "group": "IVR_Campaigns",
13853 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13854 "version": "0.0.0",
13855 "filename": "server/api/campaign/index.js",
13856 "groupTitle": "IVR_Campaigns"
13860 "url": "/api/campaigns/{id}/blacklists",
13861 "title": "Remove blacklists from an IVR Campaign",
13864 "title": "Example usage:",
13865 "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13869 "name": "RemoveBlackLists",
13870 "group": "IVR_Campaigns",
13871 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/campaign/index.js",
13874 "groupTitle": "IVR_Campaigns"
13878 "url": "/api/campaigns/{id}/lists",
13879 "title": "Remove lists from an IVR Campaign",
13882 "title": "Example usage:",
13883 "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13887 "name": "RemoveLists",
13888 "group": "IVR_Campaigns",
13889 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/campaign/index.js",
13892 "groupTitle": "IVR_Campaigns"
13896 "url": "/api/campaigns/{id}",
13897 "title": "Gets a single IVR Campaign",
13900 "title": "Example usage:",
13901 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13905 "name": "ShowIVR_Campaigns",
13906 "group": "IVR_Campaigns",
13907 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13908 "version": "0.0.0",
13909 "filename": "server/api/campaign/index.js",
13910 "groupTitle": "IVR_Campaigns"
13914 "url": "/api/campaigns/{id}/blacks",
13915 "title": "Gets IVR campaign hopper blacks",
13918 "title": "Example usage:",
13919 "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password} -X GET",
13923 "name": "getHopperBlacks",
13924 "group": "IVR_Campaigns",
13925 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13926 "version": "0.0.0",
13927 "filename": "server/api/campaign/index.js",
13928 "groupTitle": "IVR_Campaigns"
13932 "url": "/api/campaigns/{id}",
13933 "title": "Update an existing IVR Campaign",
13936 "title": "Example usage:",
13937 "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13941 "name": "updateIVR_Campaigns",
13942 "group": "IVR_Campaigns",
13943 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13944 "version": "0.0.0",
13945 "filename": "server/api/campaign/index.js",
13946 "groupTitle": "IVR_Campaigns"
13950 "url": "/api/integrations/reports",
13951 "title": "Creates a new Integration Report",
13954 "title": "Example usage:",
13955 "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13959 "name": "CreateIntegration_Reports",
13960 "group": "Integration_Reports",
13968 "field": "integration",
13975 "field": "eventChannel",
13982 "field": "exitStatus",
13989 "field": "ticketId",
13996 "field": "integrationId",
14003 "field": "contacts",
14010 "field": "uniqueid",
14017 "field": "calleridnum",
14024 "field": "calleridname",
14038 "field": "interface",
14045 "field": "membername",
14052 "field": "agentcalledAt",
14059 "field": "agentconnectAt",
14066 "field": "holdtime",
14073 "field": "agentcomplete",
14080 "field": "agentcompleteAt",
14087 "field": "talktime",
14094 "field": "agentacw",
14101 "field": "acwtime",
14115 "field": "agentringnoanswer",
14122 "field": "agentringnoanswerAt",
14129 "field": "agentdump",
14136 "field": "agentdumpAt",
14143 "field": "lastevent",
14150 "field": "channel",
14157 "field": "channelstate",
14164 "field": "channelstatedesc",
14171 "field": "connectedlinenum",
14178 "field": "connectedlinename",
14185 "field": "language",
14192 "field": "accountcode",
14199 "field": "context",
14213 "field": "priority",
14220 "field": "destchannel",
14227 "field": "destchannelstate",
14234 "field": "destchannelstatedesc",
14241 "field": "destcalleridnum",
14248 "field": "destcalleridname",
14255 "field": "destconnectedlinenum",
14262 "field": "destconnectedlinename",
14269 "field": "destlanguage",
14276 "field": "destaccountcode",
14283 "field": "destcontext",
14290 "field": "destexten",
14297 "field": "destpriority",
14304 "field": "destuniqueid",
14311 "field": "messageId",
14318 "field": "inReplyTo",
14325 "field": "subject",
14353 "field": "attachment",
14401 "field": "appdata",
14408 "field": "projectId",
14414 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14415 "version": "0.0.0",
14416 "filename": "server/api/integrationReport/index.js",
14417 "groupTitle": "Integration_Reports"
14421 "url": "/api/integrations/reports/{id}",
14422 "title": "Deletes a Integration Report",
14425 "title": "Example usage:",
14426 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
14430 "name": "DeleteIntegration_Reports",
14431 "group": "Integration_Reports",
14432 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14433 "version": "0.0.0",
14434 "filename": "server/api/integrationReport/index.js",
14435 "groupTitle": "Integration_Reports"
14439 "url": "/api/integrations/reports/describe",
14440 "title": "Gets table info about Integration Reports",
14443 "title": "Example usage:",
14444 "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
14448 "name": "DescribeIntegration_Reports",
14449 "group": "Integration_Reports",
14450 "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>",
14451 "version": "0.0.0",
14452 "filename": "server/api/integrationReport/index.js",
14453 "groupTitle": "Integration_Reports"
14457 "url": "/api/integrations/reports",
14458 "title": "Gets a list of Integration Reports",
14461 "title": "Example usage:",
14462 "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
14466 "name": "GetIntegration_Reports",
14467 "group": "Integration_Reports",
14468 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14469 "version": "0.0.0",
14470 "filename": "server/api/integrationReport/index.js",
14471 "groupTitle": "Integration_Reports"
14475 "url": "/api/integrations/reports/{id}",
14476 "title": "Gets a single Integration Report",
14479 "title": "Example usage:",
14480 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
14484 "name": "ShowIntegration_Reports",
14485 "group": "Integration_Reports",
14486 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14487 "version": "0.0.0",
14488 "filename": "server/api/integrationReport/index.js",
14489 "groupTitle": "Integration_Reports"
14493 "url": "/api/integrations/reports/{id}",
14494 "title": "Update an existing Integration Report",
14497 "title": "Example usage:",
14498 "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",
14502 "name": "updateIntegration_Reports",
14503 "group": "Integration_Reports",
14504 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14505 "version": "0.0.0",
14506 "filename": "server/api/integrationReport/index.js",
14507 "groupTitle": "Integration_Reports"
14511 "url": "/api/intervals",
14512 "title": "Creates a new Interval",
14515 "title": "Example usage:",
14516 "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14520 "name": "CreateIntervals",
14521 "group": "Intervals",
14536 "field": "description",
14543 "field": "interval",
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/interval/index.js",
14552 "groupTitle": "Intervals"
14556 "url": "/api/intervals/{id}",
14557 "title": "Deletes a Interval",
14560 "title": "Example usage:",
14561 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
14565 "name": "DeleteIntervals",
14566 "group": "Intervals",
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/interval/index.js",
14570 "groupTitle": "Intervals"
14574 "url": "/api/intervals",
14575 "title": "Gets a list of Intervals",
14578 "title": "Example usage:",
14579 "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
14583 "name": "GetIntervals",
14584 "group": "Intervals",
14585 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14586 "version": "0.0.0",
14587 "filename": "server/api/interval/index.js",
14588 "groupTitle": "Intervals"
14592 "url": "/api/intervals/{id}",
14593 "title": "Gets a single Interval",
14596 "title": "Example usage:",
14597 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
14601 "name": "ShowIntervals",
14602 "group": "Intervals",
14603 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14604 "version": "0.0.0",
14605 "filename": "server/api/interval/index.js",
14606 "groupTitle": "Intervals"
14610 "url": "/api/intervals/{id}/sub_intervals",
14611 "title": "Creates a new sub interval",
14614 "title": "Example usage:",
14615 "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",
14619 "name": "addInterval",
14620 "group": "Intervals",
14621 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14622 "version": "0.0.0",
14623 "filename": "server/api/interval/index.js",
14624 "groupTitle": "Intervals"
14628 "url": "/api/intervals/{id}/sub_intervals/create_many",
14629 "title": "Create new sub intervals set",
14632 "title": "Example usage:",
14633 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14637 "name": "addIntervals",
14638 "group": "Intervals",
14639 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14640 "version": "0.0.0",
14641 "filename": "server/api/interval/index.js",
14642 "groupTitle": "Intervals"
14646 "url": "/api/intervals/{id}/sub_intervals",
14647 "title": "Get sub intervals set",
14650 "title": "Example usage:",
14651 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
14655 "name": "getIntervals",
14656 "group": "Intervals",
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/interval/index.js",
14660 "groupTitle": "Intervals"
14664 "url": "/api/intervals/{id}",
14665 "title": "Update an existing Interval",
14668 "title": "Example usage:",
14669 "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14673 "name": "updateIntervals",
14674 "group": "Intervals",
14675 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14676 "version": "0.0.0",
14677 "filename": "server/api/interval/index.js",
14678 "groupTitle": "Intervals"
14682 "url": "/api/jira",
14683 "title": "Creates a new issue",
14686 "title": "Example usage:",
14687 "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}",
14691 "name": "Creates_Issue",
14703 "field": "issuetype",
14710 "field": "summary",
14717 "field": "description",
14723 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14724 "version": "0.0.0",
14725 "filename": "server/api/jira/index.js",
14726 "groupTitle": "Issue"
14730 "url": "/api/jscripty/answers/reports",
14731 "title": "Creates a new Report",
14734 "title": "Example usage:",
14735 "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",
14739 "name": "CreateReports",
14740 "group": "JscriptyAnswerReport",
14748 "field": "question",
14762 "field": "membername",
14769 "field": "projectname",
14783 "field": "uniqueid",
14790 "field": "calleridname",
14797 "field": "calleridnum",
14804 "field": "questionId",
14810 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14811 "version": "0.0.0",
14812 "filename": "server/api/jscriptyAnswerReport/index.js",
14813 "groupTitle": "JscriptyAnswerReport"
14817 "url": "/api/jscripty/answers/reports/{id}",
14818 "title": "Deletes a Report",
14821 "title": "Example usage:",
14822 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14826 "name": "DeleteReports",
14827 "group": "JscriptyAnswerReport",
14828 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14829 "version": "0.0.0",
14830 "filename": "server/api/jscriptyAnswerReport/index.js",
14831 "groupTitle": "JscriptyAnswerReport"
14835 "url": "/api/jscripty/answers/reports/describe",
14836 "title": "Gets table info about Reports",
14839 "title": "Example usage:",
14840 "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14844 "name": "DescribeReports",
14845 "group": "JscriptyAnswerReport",
14846 "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>",
14847 "version": "0.0.0",
14848 "filename": "server/api/jscriptyAnswerReport/index.js",
14849 "groupTitle": "JscriptyAnswerReport"
14853 "url": "/api/jscripty/answers/reports",
14854 "title": "Gets a list of Reports",
14857 "title": "Example usage:",
14858 "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14862 "name": "GetReports",
14863 "group": "JscriptyAnswerReport",
14864 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14865 "version": "0.0.0",
14866 "filename": "server/api/jscriptyAnswerReport/index.js",
14867 "groupTitle": "JscriptyAnswerReport"
14871 "url": "/api/jscripty/answers/reports/{id}",
14872 "title": "Gets a single Report",
14875 "title": "Example usage:",
14876 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14880 "name": "ShowReports",
14881 "group": "JscriptyAnswerReport",
14882 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14883 "version": "0.0.0",
14884 "filename": "server/api/jscriptyAnswerReport/index.js",
14885 "groupTitle": "JscriptyAnswerReport"
14889 "url": "/api/jscripty/answers/reports/{id}",
14890 "title": "Update an existing Report",
14893 "title": "Example usage:",
14894 "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",
14898 "name": "updateReports",
14899 "group": "JscriptyAnswerReport",
14900 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14901 "version": "0.0.0",
14902 "filename": "server/api/jscriptyAnswerReport/index.js",
14903 "groupTitle": "JscriptyAnswerReport"
14907 "url": "/api/jscripty/questions/reports",
14908 "title": "Creates a new Report",
14911 "title": "Example usage:",
14912 "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",
14916 "name": "CreateReports",
14917 "group": "JscriptyQuestionReport",
14925 "field": "question",
14939 "field": "membername",
14946 "field": "projectname",
14960 "field": "uniqueid",
14967 "field": "calleridname",
14974 "field": "calleridnum",
14981 "field": "questionId",
14987 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14988 "version": "0.0.0",
14989 "filename": "server/api/jscriptyQuestionReport/index.js",
14990 "groupTitle": "JscriptyQuestionReport"
14994 "url": "/api/jscripty/questions/reports/{id}",
14995 "title": "Deletes a Report",
14998 "title": "Example usage:",
14999 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
15003 "name": "DeleteReports",
15004 "group": "JscriptyQuestionReport",
15005 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15006 "version": "0.0.0",
15007 "filename": "server/api/jscriptyQuestionReport/index.js",
15008 "groupTitle": "JscriptyQuestionReport"
15012 "url": "/api/jscripty/questions/reports/describe",
15013 "title": "Gets table info about Reports",
15016 "title": "Example usage:",
15017 "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
15021 "name": "DescribeReports",
15022 "group": "JscriptyQuestionReport",
15023 "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>",
15024 "version": "0.0.0",
15025 "filename": "server/api/jscriptyQuestionReport/index.js",
15026 "groupTitle": "JscriptyQuestionReport"
15030 "url": "/api/jscripty/questions/reports",
15031 "title": "Gets a list of Reports",
15034 "title": "Example usage:",
15035 "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
15039 "name": "GetReports",
15040 "group": "JscriptyQuestionReport",
15041 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15042 "version": "0.0.0",
15043 "filename": "server/api/jscriptyQuestionReport/index.js",
15044 "groupTitle": "JscriptyQuestionReport"
15048 "url": "/api/jscripty/questions/reports/{id}",
15049 "title": "Gets a single Report",
15052 "title": "Example usage:",
15053 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
15057 "name": "ShowReports",
15058 "group": "JscriptyQuestionReport",
15059 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15060 "version": "0.0.0",
15061 "filename": "server/api/jscriptyQuestionReport/index.js",
15062 "groupTitle": "JscriptyQuestionReport"
15066 "url": "/api/jscripty/questions/reports/{id}",
15067 "title": "Update an existing Report",
15070 "title": "Example usage:",
15071 "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",
15075 "name": "updateReports",
15076 "group": "JscriptyQuestionReport",
15077 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15078 "version": "0.0.0",
15079 "filename": "server/api/jscriptyQuestionReport/index.js",
15080 "groupTitle": "JscriptyQuestionReport"
15084 "url": "/api/jscripty/sessions/reports",
15085 "title": "Creates a new Report",
15088 "title": "Example usage:",
15089 "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",
15093 "name": "CreateReports",
15094 "group": "JscriptySessionReport",
15102 "field": "starttime",
15109 "field": "endtime",
15116 "field": "membername",
15123 "field": "projectname",
15137 "field": "uniqueid",
15144 "field": "calleridname",
15151 "field": "calleridnum",
15158 "field": "completed",
15164 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15165 "version": "0.0.0",
15166 "filename": "server/api/jscriptySessionReport/index.js",
15167 "groupTitle": "JscriptySessionReport"
15171 "url": "/api/jscripty/sessions/reports/{id}",
15172 "title": "Deletes a Report",
15175 "title": "Example usage:",
15176 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
15180 "name": "DeleteReports",
15181 "group": "JscriptySessionReport",
15182 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15183 "version": "0.0.0",
15184 "filename": "server/api/jscriptySessionReport/index.js",
15185 "groupTitle": "JscriptySessionReport"
15189 "url": "/api/jscripty/sessions/reports/describe",
15190 "title": "Gets table info about Reports",
15193 "title": "Example usage:",
15194 "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
15198 "name": "DescribeReports",
15199 "group": "JscriptySessionReport",
15200 "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>",
15201 "version": "0.0.0",
15202 "filename": "server/api/jscriptySessionReport/index.js",
15203 "groupTitle": "JscriptySessionReport"
15207 "url": "/api/jscripty/sessions/reports",
15208 "title": "Gets a list of Reports",
15211 "title": "Example usage:",
15212 "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
15216 "name": "GetReports",
15217 "group": "JscriptySessionReport",
15218 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15219 "version": "0.0.0",
15220 "filename": "server/api/jscriptySessionReport/index.js",
15221 "groupTitle": "JscriptySessionReport"
15225 "url": "/api/jscripty/sessions/reports/{id}",
15226 "title": "Gets a single Report",
15229 "title": "Example usage:",
15230 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
15234 "name": "ShowReports",
15235 "group": "JscriptySessionReport",
15236 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15237 "version": "0.0.0",
15238 "filename": "server/api/jscriptySessionReport/index.js",
15239 "groupTitle": "JscriptySessionReport"
15243 "url": "/api/jscripty/sessions/reports/{id}/questions",
15244 "title": "Gets Jscripty Session questions",
15247 "title": "Example usage:",
15248 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password} -X GET",
15252 "name": "getQuestions",
15253 "group": "JscriptySessionReport",
15254 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15255 "version": "0.0.0",
15256 "filename": "server/api/jscriptySessionReport/index.js",
15257 "groupTitle": "JscriptySessionReport"
15261 "url": "/api/jscripty/sessions/reports/{id}",
15262 "title": "Update an existing Report",
15265 "title": "Example usage:",
15266 "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",
15270 "name": "updateReports",
15271 "group": "JscriptySessionReport",
15272 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15273 "version": "0.0.0",
15274 "filename": "server/api/jscriptySessionReport/index.js",
15275 "groupTitle": "JscriptySessionReport"
15279 "url": "/api/jscripty/projects/clone",
15280 "title": "Clone an existing Project",
15283 "title": "Example usage:",
15284 "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",
15288 "name": "CloneProjects",
15289 "group": "Jscripty_Projects",
15290 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15291 "version": "0.0.0",
15292 "filename": "server/api/jscriptyProject/index.js",
15293 "groupTitle": "Jscripty_Projects"
15297 "url": "/api/jscripty/projects",
15298 "title": "Creates a new Project",
15301 "title": "Example usage:",
15302 "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15306 "name": "CreateProjects",
15307 "group": "Jscripty_Projects",
15322 "field": "description",
15329 "field": "formData",
15336 "field": "enableUncompleteSave",
15343 "field": "sendUnpauseOnSubmit",
15349 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15350 "version": "0.0.0",
15351 "filename": "server/api/jscriptyProject/index.js",
15352 "groupTitle": "Jscripty_Projects"
15356 "url": "/api/jscripty/projects/{id}",
15357 "title": "Deletes a Project",
15360 "title": "Example usage:",
15361 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
15365 "name": "DeleteProjects",
15366 "group": "Jscripty_Projects",
15367 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15368 "version": "0.0.0",
15369 "filename": "server/api/jscriptyProject/index.js",
15370 "groupTitle": "Jscripty_Projects"
15374 "url": "/api/jscripty/projects",
15375 "title": "Gets a list of Projects",
15378 "title": "Example usage:",
15379 "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
15383 "name": "GetProjects",
15384 "group": "Jscripty_Projects",
15385 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15386 "version": "0.0.0",
15387 "filename": "server/api/jscriptyProject/index.js",
15388 "groupTitle": "Jscripty_Projects"
15392 "url": "/api/jscripty/projects/{id}",
15393 "title": "Gets a single Project",
15396 "title": "Example usage:",
15397 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
15401 "name": "ShowProjects",
15402 "group": "Jscripty_Projects",
15403 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15404 "version": "0.0.0",
15405 "filename": "server/api/jscriptyProject/index.js",
15406 "groupTitle": "Jscripty_Projects"
15410 "url": "/api/jscripty/projects/{id}/answers",
15411 "title": "Gets jscripty project answers",
15414 "title": "Example usage:",
15415 "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password} -X GET",
15419 "name": "getAnswers",
15420 "group": "Jscripty_Projects",
15421 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15422 "version": "0.0.0",
15423 "filename": "server/api/jscriptyProject/index.js",
15424 "groupTitle": "Jscripty_Projects"
15428 "url": "/api/jscripty/projects/{id}/sessions",
15429 "title": "Gets jscripty project sessions",
15432 "title": "Example usage:",
15433 "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password} -X GET",
15437 "name": "getSessions",
15438 "group": "Jscripty_Projects",
15439 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15440 "version": "0.0.0",
15441 "filename": "server/api/jscriptyProject/index.js",
15442 "groupTitle": "Jscripty_Projects"
15446 "url": "/api/jscripty/projects/{id}/summary",
15447 "title": "Gets jscripty project summary",
15450 "title": "Example usage:",
15451 "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password} -X GET",
15455 "name": "getSummary",
15456 "group": "Jscripty_Projects",
15457 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15458 "version": "0.0.0",
15459 "filename": "server/api/jscriptyProject/index.js",
15460 "groupTitle": "Jscripty_Projects"
15464 "url": "/api/jscripty/projects/{id}",
15465 "title": "Update an existing Project",
15468 "title": "Example usage:",
15469 "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",
15473 "name": "updateProjects",
15474 "group": "Jscripty_Projects",
15475 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15476 "version": "0.0.0",
15477 "filename": "server/api/jscriptyProject/index.js",
15478 "groupTitle": "Jscripty_Projects"
15482 "url": "/api/license",
15483 "title": "Gets License Info",
15486 "title": "Example usage:",
15487 "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
15492 "group": "License",
15493 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15494 "version": "0.0.0",
15495 "filename": "server/api/license/index.js",
15496 "groupTitle": "License"
15500 "url": "/api/license/{id}",
15501 "title": "Update License Info",
15504 "title": "Example usage:",
15505 "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
15510 "group": "License",
15511 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15512 "version": "0.0.0",
15513 "filename": "server/api/license/index.js",
15514 "groupTitle": "License"
15518 "url": "/api/mail_interaction_has_tags/describe",
15519 "title": "Gets table info about Mail Iteraction Tags",
15522 "title": "Example usage:",
15523 "content": "curl https://{domain}/api/mail_interaction_has_tags/describe -v -u {name}:{password}",
15527 "name": "DescribeMailInteractionTags",
15528 "group": "MailInteractionTags",
15529 "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>",
15530 "version": "0.0.0",
15531 "filename": "server/api/mailInteractionHasTag/index.js",
15532 "groupTitle": "MailInteractionTags"
15536 "url": "/api/mail/accounts/{id}/users",
15537 "title": "Add agents to a mail account",
15540 "title": "Example usage:",
15541 "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",
15545 "name": "AddAgents",
15546 "group": "Mail_Accounts",
15547 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15548 "version": "0.0.0",
15549 "filename": "server/api/mailAccount/index.js",
15550 "groupTitle": "Mail_Accounts"
15554 "url": "/api/mail/accounts/{id}/in_servers",
15555 "title": "Creates a new IMAP server",
15558 "title": "Example usage:",
15559 "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",
15564 "group": "Mail_Accounts",
15572 "field": "description",
15586 "field": "authentication",
15600 "field": "password",
15621 "field": "mailbox",
15628 "field": "connTimeout",
15635 "field": "authTimeout",
15642 "field": "service",
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}/out_servers",
15656 "title": "Creates a new SMTP server",
15659 "title": "Example usage:",
15660 "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",
15665 "group": "Mail_Accounts",
15673 "field": "description",
15715 "field": "service",
15722 "field": "authentication",
15728 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15729 "version": "0.0.0",
15730 "filename": "server/api/mailAccount/index.js",
15731 "groupTitle": "Mail_Accounts"
15735 "url": "/api/mail/accounts/{id}",
15736 "title": "Deletes a mail account",
15739 "title": "Example usage:",
15740 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
15744 "name": "DeleteMailAccounts",
15745 "group": "Mail_Accounts",
15746 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15747 "version": "0.0.0",
15748 "filename": "server/api/mailAccount/index.js",
15749 "groupTitle": "Mail_Accounts"
15753 "url": "/api/mail/accounts/describe",
15754 "title": "Gets table info about Accounts",
15757 "title": "Example usage:",
15758 "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
15762 "name": "DescribeAccounts",
15763 "group": "Mail_Accounts",
15764 "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>",
15765 "version": "0.0.0",
15766 "filename": "server/api/mailAccount/index.js",
15767 "groupTitle": "Mail_Accounts"
15771 "url": "/api/mail/accounts",
15772 "title": "Gets a list of Accounts",
15775 "title": "Example usage:",
15776 "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
15780 "name": "GetAccounts",
15781 "group": "Mail_Accounts",
15782 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15783 "version": "0.0.0",
15784 "filename": "server/api/mailAccount/index.js",
15785 "groupTitle": "Mail_Accounts"
15789 "url": "/api/mail/accounts/{id}/users",
15790 "title": "Gets agents from mail account",
15793 "title": "Example usage:",
15794 "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
15798 "name": "GetAgents",
15799 "group": "Mail_Accounts",
15800 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15801 "version": "0.0.0",
15802 "filename": "server/api/mailAccount/index.js",
15803 "groupTitle": "Mail_Accounts"
15807 "url": "/api/mail/accounts/{id}/in_servers",
15808 "title": "Gets account IMAP server",
15811 "title": "Example usage:",
15812 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
15817 "group": "Mail_Accounts",
15818 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15819 "version": "0.0.0",
15820 "filename": "server/api/mailAccount/index.js",
15821 "groupTitle": "Mail_Accounts"
15825 "url": "/api/mail/accounts/{id}/out_servers",
15826 "title": "Gets account SMTP server",
15829 "title": "Example usage:",
15830 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15835 "group": "Mail_Accounts",
15836 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15837 "version": "0.0.0",
15838 "filename": "server/api/mailAccount/index.js",
15839 "groupTitle": "Mail_Accounts"
15843 "url": "/api/mail/accounts/{id}/users",
15844 "title": "Removes agents from a mail account",
15847 "title": "Example usage:",
15848 "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15852 "name": "RemoveAgents",
15853 "group": "Mail_Accounts",
15854 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15855 "version": "0.0.0",
15856 "filename": "server/api/mailAccount/index.js",
15857 "groupTitle": "Mail_Accounts"
15861 "url": "/api/mail/accounts/{id}/canned_answers",
15862 "title": "Removes canned answers from account",
15865 "title": "Example usage:",
15866 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15870 "name": "RemoveAnswers",
15871 "group": "Mail_Accounts",
15872 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15873 "version": "0.0.0",
15874 "filename": "server/api/mailAccount/index.js",
15875 "groupTitle": "Mail_Accounts"
15879 "url": "/api/mail/accounts/{id}/dispositions",
15880 "title": "Removes dispositions from account",
15883 "title": "Example usage:",
15884 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15888 "name": "RemoveDispositions",
15889 "group": "Mail_Accounts",
15890 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15891 "version": "0.0.0",
15892 "filename": "server/api/mailAccount/index.js",
15893 "groupTitle": "Mail_Accounts"
15897 "url": "/api/mail/accounts/{id}/in_servers",
15898 "title": "Removes IMAP server from an account",
15901 "title": "Example usage:",
15902 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15906 "name": "RemoveImmap",
15907 "group": "Mail_Accounts",
15908 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15909 "version": "0.0.0",
15910 "filename": "server/api/mailAccount/index.js",
15911 "groupTitle": "Mail_Accounts"
15915 "url": "/api/mail/accounts/{id}/out_servers",
15916 "title": "Removes SMTP server from an account",
15919 "title": "Example usage:",
15920 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15924 "name": "RemoveSmtp",
15925 "group": "Mail_Accounts",
15926 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15927 "version": "0.0.0",
15928 "filename": "server/api/mailAccount/index.js",
15929 "groupTitle": "Mail_Accounts"
15933 "url": "/api/mail/accounts/{id}",
15934 "title": "Gets a single Account",
15937 "title": "Example usage:",
15938 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15942 "name": "ShowAccounts",
15943 "group": "Mail_Accounts",
15944 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15945 "version": "0.0.0",
15946 "filename": "server/api/mailAccount/index.js",
15947 "groupTitle": "Mail_Accounts"
15951 "url": "/api/mail/accounts/{id}/canned_answers",
15952 "title": "Creates new canned answer",
15955 "title": "Example usage:",
15956 "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",
15960 "name": "addAnswer",
15961 "group": "Mail_Accounts",
15983 "field": "description",
15996 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15997 "version": "0.0.0",
15998 "filename": "server/api/mailAccount/index.js",
15999 "groupTitle": "Mail_Accounts"
16003 "url": "/api/mail/accounts/{id}/applications",
16004 "title": "Creates new applications",
16007 "title": "Example usage:",
16008 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16012 "name": "addApplications",
16013 "group": "Mail_Accounts",
16021 "field": "priority",
16035 "field": "appdata",
16042 "field": "description",
16049 "field": "interval",
16055 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16056 "version": "0.0.0",
16057 "filename": "server/api/mailAccount/index.js",
16058 "groupTitle": "Mail_Accounts"
16062 "url": "/api/mail/accounts/{id}/dispositions",
16063 "title": "Creates new disposition",
16066 "title": "Example usage:",
16067 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16071 "name": "addDisposition",
16072 "group": "Mail_Accounts",
16099 "field": "description",
16105 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16106 "version": "0.0.0",
16107 "filename": "server/api/mailAccount/index.js",
16108 "groupTitle": "Mail_Accounts"
16112 "url": "/api/mail/accounts/{id}/interactions",
16113 "title": "Creates new interactions",
16116 "title": "Example usage:",
16117 "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",
16121 "name": "addInteraction",
16122 "group": "Mail_Accounts",
16137 "field": "closedAt",
16144 "field": "disposition",
16151 "field": "secondDisposition",
16158 "field": "thirdDisposition",
16172 "field": "inReplyTo",
16193 "field": "subject",
16207 "field": "read1stAt",
16214 "field": "substatus",
16221 "field": "substatusAt",
16232 "field": "firstMsgDirection",
16239 "field": "lastMsgAt",
16250 "field": "lastMsgDirection",
16257 "field": "autoreplyExecuted",
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/mailAccount/index.js",
16266 "groupTitle": "Mail_Accounts"
16270 "url": "/api/mail/accounts",
16271 "title": "Create a mail account",
16274 "title": "Example usage:",
16275 "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16280 "group": "Mail_Accounts",
16281 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16282 "version": "0.0.0",
16283 "filename": "server/api/mailAccount/index.js",
16284 "groupTitle": "Mail_Accounts"
16288 "url": "/api/mail/accounts/{id}/canned_answers",
16289 "title": "Gets account canned answers",
16292 "title": "Example usage:",
16293 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
16297 "name": "getAnswers",
16298 "group": "Mail_Accounts",
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/mailAccount/index.js",
16302 "groupTitle": "Mail_Accounts"
16306 "url": "/api/mail/accounts/{id}/applications",
16307 "title": "Gets account applications",
16310 "title": "Example usage:",
16311 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
16315 "name": "getApplications",
16316 "group": "Mail_Accounts",
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/mailAccount/index.js",
16320 "groupTitle": "Mail_Accounts"
16324 "url": "/api/mail/accounts/{id}/dispositions",
16325 "title": "Gets account dispositions",
16328 "title": "Example usage:",
16329 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
16333 "name": "getDispositions",
16334 "group": "Mail_Accounts",
16335 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/mailAccount/index.js",
16338 "groupTitle": "Mail_Accounts"
16342 "url": "/api/mail/accounts/{id}/interactions",
16343 "title": "Gets account interactions",
16346 "title": "Example usage:",
16347 "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
16351 "name": "getInteraction",
16352 "group": "Mail_Accounts",
16353 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16354 "version": "0.0.0",
16355 "filename": "server/api/mailAccount/index.js",
16356 "groupTitle": "Mail_Accounts"
16360 "url": "/api/mail/accounts/{id}/messages",
16361 "title": "Gets account messages",
16364 "title": "Example usage:",
16365 "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
16369 "name": "getMessages",
16370 "group": "Mail_Accounts",
16371 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16372 "version": "0.0.0",
16373 "filename": "server/api/mailAccount/index.js",
16374 "groupTitle": "Mail_Accounts"
16378 "url": "/api/mail/accounts/{id}/send",
16379 "title": "Send new mail",
16382 "title": "Example usage:",
16383 "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",
16387 "name": "sendMail",
16388 "group": "Mail_Accounts",
16389 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16390 "version": "0.0.0",
16391 "filename": "server/api/mailAccount/index.js",
16392 "groupTitle": "Mail_Accounts"
16396 "url": "/api/mail/accounts/{id}",
16397 "title": "Update an existing Account",
16400 "title": "Example usage:",
16401 "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",
16405 "name": "updateAccounts",
16406 "group": "Mail_Accounts",
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/mailAccount/index.js",
16410 "groupTitle": "Mail_Accounts"
16414 "url": "/api/mail/accounts/{id}/verify",
16415 "title": "Verify mail account",
16418 "title": "Example usage:",
16419 "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
16423 "name": "verifySmtp",
16424 "group": "Mail_Accounts",
16425 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16426 "version": "0.0.0",
16427 "filename": "server/api/mailAccount/index.js",
16428 "groupTitle": "Mail_Accounts"
16432 "url": "/api/mail/applications/{id}",
16433 "title": "Deletes a Application",
16436 "title": "Example usage:",
16437 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
16441 "name": "DeleteApplications",
16442 "group": "Mail_Applications",
16443 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/mailApplication/index.js",
16446 "groupTitle": "Mail_Applications"
16450 "url": "/api/mail/applications/{id}",
16451 "title": "Gets a single Application",
16454 "title": "Example usage:",
16455 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
16459 "name": "ShowApplications",
16460 "group": "Mail_Applications",
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/mailApplication/index.js",
16464 "groupTitle": "Mail_Applications"
16468 "url": "/api/mail/applications/{id}",
16469 "title": "Update an existing Application",
16472 "title": "Example usage:",
16473 "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",
16477 "name": "updateApplications",
16478 "group": "Mail_Applications",
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/mailApplication/index.js",
16482 "groupTitle": "Mail_Applications"
16486 "url": "/api/mail/interactions/{id}/tags",
16487 "title": "Add tags to the interaction",
16490 "title": "Example usage:",
16491 "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",
16496 "group": "Mail_Interactions",
16497 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16498 "version": "0.0.0",
16499 "filename": "server/api/mailInteraction/index.js",
16500 "groupTitle": "Mail_Interactions"
16504 "url": "/api/mail/interactions",
16505 "title": "Creates a new Interaction",
16508 "title": "Example usage:",
16509 "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16513 "name": "CreateInteractions",
16514 "group": "Mail_Interactions",
16529 "field": "closedAt",
16536 "field": "disposition",
16543 "field": "secondDisposition",
16550 "field": "thirdDisposition",
16564 "field": "inReplyTo",
16585 "field": "subject",
16599 "field": "read1stAt",
16606 "field": "substatus",
16613 "field": "substatusAt",
16624 "field": "firstMsgDirection",
16631 "field": "lastMsgAt",
16642 "field": "lastMsgDirection",
16649 "field": "autoreplyExecuted",
16655 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16656 "version": "0.0.0",
16657 "filename": "server/api/mailInteraction/index.js",
16658 "groupTitle": "Mail_Interactions"
16662 "url": "/api/mail/interactions/{id}",
16663 "title": "Deletes a Interaction",
16666 "title": "Example usage:",
16667 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
16671 "name": "DeleteInteractions",
16672 "group": "Mail_Interactions",
16673 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16674 "version": "0.0.0",
16675 "filename": "server/api/mailInteraction/index.js",
16676 "groupTitle": "Mail_Interactions"
16680 "url": "/api/mail/interactions/describe",
16681 "title": "Gets table info about Interactions",
16684 "title": "Example usage:",
16685 "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
16689 "name": "DescribeInteractions",
16690 "group": "Mail_Interactions",
16691 "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>",
16692 "version": "0.0.0",
16693 "filename": "server/api/mailInteraction/index.js",
16694 "groupTitle": "Mail_Interactions"
16698 "url": "/api/mail/interactions",
16699 "title": "Gets a list of Interactions",
16702 "title": "Example usage:",
16703 "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
16707 "name": "GetInteractions",
16708 "group": "Mail_Interactions",
16709 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16710 "version": "0.0.0",
16711 "filename": "server/api/mailInteraction/index.js",
16712 "groupTitle": "Mail_Interactions"
16716 "url": "/api/mail/interactions/{id}/tags",
16717 "title": "Removes tags from interaction",
16720 "title": "Example usage:",
16721 "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16725 "name": "RemoveTags",
16726 "group": "Mail_Interactions",
16727 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16728 "version": "0.0.0",
16729 "filename": "server/api/mailInteraction/index.js",
16730 "groupTitle": "Mail_Interactions"
16734 "url": "/api/mail/interactions/{id}",
16735 "title": "Gets a single Interaction",
16738 "title": "Example usage:",
16739 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
16743 "name": "ShowInteractions",
16744 "group": "Mail_Interactions",
16745 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16746 "version": "0.0.0",
16747 "filename": "server/api/mailInteraction/index.js",
16748 "groupTitle": "Mail_Interactions"
16752 "url": "/api/mail/interactions/{id}/messages",
16753 "title": "Creates new message",
16756 "title": "Example usage:",
16757 "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",
16761 "name": "addMessage",
16762 "group": "Mail_Interactions",
16777 "field": "plainBody",
16795 "field": "direction",
16802 "field": "messageId",
16837 "field": "subject",
16872 "field": "originTo",
16879 "field": "originCc",
16890 "field": "originChannel",
16896 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16897 "version": "0.0.0",
16898 "filename": "server/api/mailInteraction/index.js",
16899 "groupTitle": "Mail_Interactions"
16903 "url": "/api/mail/interactions/{id}/download",
16904 "title": "Gets interaction",
16907 "title": "Example usage:",
16908 "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16912 "name": "download",
16913 "group": "Mail_Interactions",
16914 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16915 "version": "0.0.0",
16916 "filename": "server/api/mailInteraction/index.js",
16917 "groupTitle": "Mail_Interactions"
16921 "url": "/api/mail/interactions/{id}/messages",
16922 "title": "Gets interaction messages",
16925 "title": "Example usage:",
16926 "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16930 "name": "getMessages",
16931 "group": "Mail_Interactions",
16932 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16933 "version": "0.0.0",
16934 "filename": "server/api/mailInteraction/index.js",
16935 "groupTitle": "Mail_Interactions"
16939 "url": "/api/mail/interactions/{id}",
16940 "title": "Update an existing Interaction",
16943 "title": "Example usage:",
16944 "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",
16948 "name": "updateInteractions",
16949 "group": "Mail_Interactions",
16950 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16951 "version": "0.0.0",
16952 "filename": "server/api/mailInteraction/index.js",
16953 "groupTitle": "Mail_Interactions"
16957 "url": "/api/mail/messages/{id}",
16958 "title": "Deletes a Message",
16961 "title": "Example usage:",
16962 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16966 "name": "DeleteMessages",
16967 "group": "Mail_Messages",
16968 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16969 "version": "0.0.0",
16970 "filename": "server/api/mailMessage/index.js",
16971 "groupTitle": "Mail_Messages"
16975 "url": "/api/mail/messages/describe",
16976 "title": "Gets table info about Messages",
16979 "title": "Example usage:",
16980 "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16984 "name": "DescribeMessages",
16985 "group": "Mail_Messages",
16986 "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>",
16987 "version": "0.0.0",
16988 "filename": "server/api/mailMessage/index.js",
16989 "groupTitle": "Mail_Messages"
16993 "url": "/api/mail/messages",
16994 "title": "Gets a list of Messages",
16997 "title": "Example usage:",
16998 "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
17002 "name": "GetMessages",
17003 "group": "Mail_Messages",
17004 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17005 "version": "0.0.0",
17006 "filename": "server/api/mailMessage/index.js",
17007 "groupTitle": "Mail_Messages"
17011 "url": "/api/mail/messages/{id}",
17012 "title": "Gets a single Message",
17015 "title": "Example usage:",
17016 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
17020 "name": "ShowMessages",
17021 "group": "Mail_Messages",
17022 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17023 "version": "0.0.0",
17024 "filename": "server/api/mailMessage/index.js",
17025 "groupTitle": "Mail_Messages"
17029 "url": "/api/mail/messages/{id}/accept",
17030 "title": "Accepts message",
17033 "title": "Example usage:",
17034 "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
17038 "name": "acceptMessage",
17039 "group": "Mail_Messages",
17040 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17041 "version": "0.0.0",
17042 "filename": "server/api/mailMessage/index.js",
17043 "groupTitle": "Mail_Messages"
17047 "url": "/api/mail/messages",
17048 "title": "Create a message",
17051 "title": "Example usage:",
17052 "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17056 "name": "createMessage",
17057 "group": "Mail_Messages",
17058 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17059 "version": "0.0.0",
17060 "filename": "server/api/mailMessage/index.js",
17061 "groupTitle": "Mail_Messages"
17065 "url": "/api/mail/messages/{id}/download",
17066 "title": "Gets message",
17069 "title": "Example usage:",
17070 "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
17074 "name": "download",
17075 "group": "Mail_Messages",
17076 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17077 "version": "0.0.0",
17078 "filename": "server/api/mailMessage/index.js",
17079 "groupTitle": "Mail_Messages"
17083 "url": "/api/mail/messages/{id}/reject",
17084 "title": "Rejects message",
17087 "title": "Example usage:",
17088 "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
17092 "name": "rejectMessage",
17093 "group": "Mail_Messages",
17094 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17095 "version": "0.0.0",
17096 "filename": "server/api/mailMessage/index.js",
17097 "groupTitle": "Mail_Messages"
17101 "url": "/api/mail/messages/{id}",
17102 "title": "Update an existing Message",
17105 "title": "Example usage:",
17106 "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",
17110 "name": "updateMessages",
17111 "group": "Mail_Messages",
17112 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17113 "version": "0.0.0",
17114 "filename": "server/api/mailMessage/index.js",
17115 "groupTitle": "Mail_Messages"
17119 "url": "/api/mail/reports/queue",
17120 "title": "Creates a new Mail Queue Report",
17123 "title": "Example usage:",
17124 "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",
17128 "name": "CreateMail_Queue_Reports",
17129 "group": "Mail_Queue_Reports",
17137 "field": "uniqueid",
17158 "field": "leaveAt",
17165 "field": "acceptAt",
17185 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17186 "version": "0.0.0",
17187 "filename": "server/api/mailQueueReport/index.js",
17188 "groupTitle": "Mail_Queue_Reports"
17192 "url": "/api/mail/reports/queue/{id}",
17193 "title": "Deletes a Mail Queue Report",
17196 "title": "Example usage:",
17197 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
17201 "name": "DeleteMail_Queue_Reports",
17202 "group": "Mail_Queue_Reports",
17203 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17204 "version": "0.0.0",
17205 "filename": "server/api/mailQueueReport/index.js",
17206 "groupTitle": "Mail_Queue_Reports"
17210 "url": "/api/mail/reports/queue/describe",
17211 "title": "Gets table info about Mail Queue Reports",
17214 "title": "Example usage:",
17215 "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
17219 "name": "DescribeMail_Queue_Reports",
17220 "group": "Mail_Queue_Reports",
17221 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17222 "version": "0.0.0",
17223 "filename": "server/api/mailQueueReport/index.js",
17224 "groupTitle": "Mail_Queue_Reports"
17228 "url": "/api/mail/reports/queue",
17229 "title": "Gets a list of Mail Queue Reports",
17232 "title": "Example usage:",
17233 "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
17237 "name": "GetMail_Queue_Reports",
17238 "group": "Mail_Queue_Reports",
17239 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/mail/reports/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>",
17240 "version": "0.0.0",
17241 "filename": "server/api/mailQueueReport/index.js",
17242 "groupTitle": "Mail_Queue_Reports"
17246 "url": "/api/mail/reports/queue/{id}",
17247 "title": "Gets a single Mail Queue Report",
17250 "title": "Example usage:",
17251 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
17255 "name": "ShowMail_Queue_Reports",
17256 "group": "Mail_Queue_Reports",
17257 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17258 "version": "0.0.0",
17259 "filename": "server/api/mailQueueReport/index.js",
17260 "groupTitle": "Mail_Queue_Reports"
17264 "url": "/api/mail/reports/queue/{id}",
17265 "title": "Update an existing Mail Queue Report",
17268 "title": "Example usage:",
17269 "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",
17273 "name": "updateMail_Queue_Reports",
17274 "group": "Mail_Queue_Reports",
17275 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17276 "version": "0.0.0",
17277 "filename": "server/api/mailQueueReport/index.js",
17278 "groupTitle": "Mail_Queue_Reports"
17282 "url": "/api/mail/queues/{id}/users",
17283 "title": "Add agents to a queue",
17286 "title": "Example usage:",
17287 "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",
17291 "name": "AddAgents",
17292 "group": "Mail_Queues",
17293 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17294 "version": "0.0.0",
17295 "filename": "server/api/mailQueue/index.js",
17296 "groupTitle": "Mail_Queues"
17300 "url": "/api/mail/queues/{id}/teams",
17301 "title": "Add teams to a queue",
17304 "title": "Example usage:",
17305 "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",
17309 "name": "AddTeams",
17310 "group": "Mail_Queues",
17311 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17312 "version": "0.0.0",
17313 "filename": "server/api/mailQueue/index.js",
17314 "groupTitle": "Mail_Queues"
17318 "url": "/api/mail/queues",
17319 "title": "Creates a new Queue",
17322 "title": "Example usage:",
17323 "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17327 "name": "CreateQueues",
17328 "group": "Mail_Queues",
17343 "field": "description",
17350 "field": "timeout",
17362 "field": "strategy",
17368 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17369 "version": "0.0.0",
17370 "filename": "server/api/mailQueue/index.js",
17371 "groupTitle": "Mail_Queues"
17375 "url": "/api/mail/queues/{id}",
17376 "title": "Deletes a Queue",
17379 "title": "Example usage:",
17380 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
17384 "name": "DeleteQueues",
17385 "group": "Mail_Queues",
17386 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17387 "version": "0.0.0",
17388 "filename": "server/api/mailQueue/index.js",
17389 "groupTitle": "Mail_Queues"
17393 "url": "/api/mail/queues/describe",
17394 "title": "Gets table info about Queues",
17397 "title": "Example usage:",
17398 "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
17402 "name": "DescribeQueues",
17403 "group": "Mail_Queues",
17404 "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>",
17405 "version": "0.0.0",
17406 "filename": "server/api/mailQueue/index.js",
17407 "groupTitle": "Mail_Queues"
17411 "url": "/api/mail/queues/{id}/users",
17412 "title": "Gets queue agents",
17415 "title": "Example usage:",
17416 "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
17420 "name": "GetAgents",
17421 "group": "Mail_Queues",
17422 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17423 "version": "0.0.0",
17424 "filename": "server/api/mailQueue/index.js",
17425 "groupTitle": "Mail_Queues"
17429 "url": "/api/mail/queues/{id}/members",
17430 "title": "GetMembers",
17433 "title": "Example usage:",
17434 "content": "curl https://{domain}/api/mail/queues/{id}/members -v -u {name}:{password}",
17438 "name": "GetMembers",
17439 "group": "Mail_Queues",
17440 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17441 "version": "0.0.0",
17442 "filename": "server/api/mailQueue/index.js",
17443 "groupTitle": "Mail_Queues"
17447 "url": "/api/mail/queues",
17448 "title": "Gets a list of Queues",
17451 "title": "Example usage:",
17452 "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
17456 "name": "GetQueues",
17457 "group": "Mail_Queues",
17458 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17459 "version": "0.0.0",
17460 "filename": "server/api/mailQueue/index.js",
17461 "groupTitle": "Mail_Queues"
17465 "url": "/api/mail/queues/{id}/teams",
17466 "title": "Gets queues list",
17469 "title": "Example usage:",
17470 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
17474 "name": "GetTeams",
17475 "group": "Mail_Queues",
17476 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17477 "version": "0.0.0",
17478 "filename": "server/api/mailQueue/index.js",
17479 "groupTitle": "Mail_Queues"
17483 "url": "/api/mail/queues/{id}/users",
17484 "title": "Removes agents from a queue",
17487 "title": "Example usage:",
17488 "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17492 "name": "RemoveAgents",
17493 "group": "Mail_Queues",
17494 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17495 "version": "0.0.0",
17496 "filename": "server/api/mailQueue/index.js",
17497 "groupTitle": "Mail_Queues"
17501 "url": "/api/mail/queues/{id}",
17502 "title": "Gets a single Queue",
17505 "title": "Example usage:",
17506 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
17510 "name": "ShowQueues",
17511 "group": "Mail_Queues",
17512 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17513 "version": "0.0.0",
17514 "filename": "server/api/mailQueue/index.js",
17515 "groupTitle": "Mail_Queues"
17519 "url": "/api/mail/queues/{id}",
17520 "title": "Update an existing Queue",
17523 "title": "Example usage:",
17524 "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",
17528 "name": "updateQueues",
17529 "group": "Mail_Queues",
17530 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17531 "version": "0.0.0",
17532 "filename": "server/api/mailQueue/index.js",
17533 "groupTitle": "Mail_Queues"
17537 "url": "/api/mail/out_servers",
17538 "title": "Creates a new SMTP",
17541 "title": "Example usage:",
17542 "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",
17546 "name": "CreateSMTPs",
17547 "group": "Mail_SMTP",
17555 "field": "description",
17597 "field": "service",
17604 "field": "authentication",
17610 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17611 "version": "0.0.0",
17612 "filename": "server/api/mailServerOut/index.js",
17613 "groupTitle": "Mail_SMTP"
17617 "url": "/api/mail/out_servers/{id}",
17618 "title": "Deletes a SMTP",
17621 "title": "Example usage:",
17622 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
17626 "name": "DeleteSMTPs",
17627 "group": "Mail_SMTP",
17628 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17629 "version": "0.0.0",
17630 "filename": "server/api/mailServerOut/index.js",
17631 "groupTitle": "Mail_SMTP"
17635 "url": "/api/mail/out_servers",
17636 "title": "Gets a list of SMTPs",
17639 "title": "Example usage:",
17640 "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
17644 "name": "GetSMTPs",
17645 "group": "Mail_SMTP",
17646 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17647 "version": "0.0.0",
17648 "filename": "server/api/mailServerOut/index.js",
17649 "groupTitle": "Mail_SMTP"
17653 "url": "/api/mail/out_servers/{id}",
17654 "title": "Gets a single SMTP",
17657 "title": "Example usage:",
17658 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
17662 "name": "ShowSMTPs",
17663 "group": "Mail_SMTP",
17664 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17665 "version": "0.0.0",
17666 "filename": "server/api/mailServerOut/index.js",
17667 "groupTitle": "Mail_SMTP"
17671 "url": "/api/mail/out_servers/{id}",
17672 "title": "Update an existing SMTP",
17675 "title": "Example usage:",
17676 "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",
17680 "name": "updateSMTPs",
17681 "group": "Mail_SMTP",
17682 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17683 "version": "0.0.0",
17684 "filename": "server/api/mailServerOut/index.js",
17685 "groupTitle": "Mail_SMTP"
17689 "url": "/api/mail/substatuses",
17690 "title": "Creates a new Queue",
17693 "title": "Example usage:",
17694 "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17698 "name": "CreateSubstatuses",
17699 "group": "Mail_Substatuses",
17714 "field": "description",
17720 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17721 "version": "0.0.0",
17722 "filename": "server/api/mailSubstatus/index.js",
17723 "groupTitle": "Mail_Substatuses"
17727 "url": "/api/mail/substatuses/{id}",
17728 "title": "Deletes a Queue",
17731 "title": "Example usage:",
17732 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
17736 "name": "DeleteSubstatuses",
17737 "group": "Mail_Substatuses",
17738 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17739 "version": "0.0.0",
17740 "filename": "server/api/mailSubstatus/index.js",
17741 "groupTitle": "Mail_Substatuses"
17745 "url": "/api/mail/substatuses/describe",
17746 "title": "Gets table info about Substatuses",
17749 "title": "Example usage:",
17750 "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
17754 "name": "DescribeSubstatuses",
17755 "group": "Mail_Substatuses",
17756 "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>",
17757 "version": "0.0.0",
17758 "filename": "server/api/mailSubstatus/index.js",
17759 "groupTitle": "Mail_Substatuses"
17763 "url": "/api/mail/substatuses",
17764 "title": "Gets a list of Substatuses",
17767 "title": "Example usage:",
17768 "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
17772 "name": "GetSubstatuses",
17773 "group": "Mail_Substatuses",
17774 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17775 "version": "0.0.0",
17776 "filename": "server/api/mailSubstatus/index.js",
17777 "groupTitle": "Mail_Substatuses"
17781 "url": "/api/mail/substatuses/{id}",
17782 "title": "Gets a single Queue",
17785 "title": "Example usage:",
17786 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
17790 "name": "ShowSubstatuses",
17791 "group": "Mail_Substatuses",
17792 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17793 "version": "0.0.0",
17794 "filename": "server/api/mailSubstatus/index.js",
17795 "groupTitle": "Mail_Substatuses"
17799 "url": "/api/mail/substatuses/{id}",
17800 "title": "Update an existing Queue",
17803 "title": "Example usage:",
17804 "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",
17808 "name": "updateSubstatuses",
17809 "group": "Mail_Substatuses",
17810 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17811 "version": "0.0.0",
17812 "filename": "server/api/mailSubstatus/index.js",
17813 "groupTitle": "Mail_Substatuses"
17817 "url": "/api/mail/reports/transfer",
17818 "title": "Creates a new Mail Transfer Report",
17821 "title": "Example usage:",
17822 "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",
17826 "name": "CreateMail_Transfer_Reports",
17827 "group": "Mail_Transfer_Reports",
17835 "field": "uniqueid",
17854 "field": "transferredAt",
17860 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17861 "version": "0.0.0",
17862 "filename": "server/api/mailTransferReport/index.js",
17863 "groupTitle": "Mail_Transfer_Reports"
17867 "url": "/api/mail/reports/transfer/{id}",
17868 "title": "Deletes a Mail Transfer Report",
17871 "title": "Example usage:",
17872 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17876 "name": "DeleteMail_Transfer_Reports",
17877 "group": "Mail_Transfer_Reports",
17878 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17879 "version": "0.0.0",
17880 "filename": "server/api/mailTransferReport/index.js",
17881 "groupTitle": "Mail_Transfer_Reports"
17885 "url": "/api/mail/reports/transfer/describe",
17886 "title": "Gets table info about Mail Transfer Reports",
17889 "title": "Example usage:",
17890 "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17894 "name": "DescribeMail_Transfer_Reports",
17895 "group": "Mail_Transfer_Reports",
17896 "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>",
17897 "version": "0.0.0",
17898 "filename": "server/api/mailTransferReport/index.js",
17899 "groupTitle": "Mail_Transfer_Reports"
17903 "url": "/api/mail/reports/transfer",
17904 "title": "Gets a list of Mail Transfer Reports",
17907 "title": "Example usage:",
17908 "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17912 "name": "GetMail_Transfer_Reports",
17913 "group": "Mail_Transfer_Reports",
17914 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17915 "version": "0.0.0",
17916 "filename": "server/api/mailTransferReport/index.js",
17917 "groupTitle": "Mail_Transfer_Reports"
17921 "url": "/api/mail/reports/transfer/{id}",
17922 "title": "Gets a single Mail Transfer Report",
17925 "title": "Example usage:",
17926 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17930 "name": "ShowMail_Transfer_Reports",
17931 "group": "Mail_Transfer_Reports",
17932 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17933 "version": "0.0.0",
17934 "filename": "server/api/mailTransferReport/index.js",
17935 "groupTitle": "Mail_Transfer_Reports"
17939 "url": "/api/mail/reports/transfer/{id}",
17940 "title": "Update an existing Mail Transfer Report",
17943 "title": "Example usage:",
17944 "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",
17948 "name": "updateMail_Transfer_Reports",
17949 "group": "Mail_Transfer_Reports",
17950 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17951 "version": "0.0.0",
17952 "filename": "server/api/mailTransferReport/index.js",
17953 "groupTitle": "Mail_Transfer_Reports"
17957 "url": "/api/members/reports/describe",
17958 "title": "Gets table info about Member Reports",
17961 "title": "Example usage:",
17962 "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17966 "name": "DescribeMember_Reports",
17967 "group": "Member_Reports",
17968 "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>",
17969 "version": "0.0.0",
17970 "filename": "server/api/memberReport/index.js",
17971 "groupTitle": "Member_Reports"
17975 "url": "/api/members/reports",
17976 "title": "Gets a list of Member Reports",
17979 "title": "Example usage:",
17980 "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17984 "name": "GetMember_Reports",
17985 "group": "Member_Reports",
17986 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17987 "version": "0.0.0",
17988 "filename": "server/api/memberReport/index.js",
17989 "groupTitle": "Member_Reports"
17993 "url": "/api/members/reports/{id}",
17994 "title": "Gets a single Member Report",
17997 "title": "Example usage:",
17998 "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
18002 "name": "ShowMember_Reports",
18003 "group": "Member_Reports",
18004 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18005 "version": "0.0.0",
18006 "filename": "server/api/memberReport/index.js",
18007 "groupTitle": "Member_Reports"
18011 "url": "/api/migrations",
18012 "title": "Gets a list of Migrations",
18015 "title": "Example usage:",
18016 "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
18020 "name": "GetMigrations",
18021 "group": "Migrations",
18022 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18023 "version": "0.0.0",
18024 "filename": "server/api/migration/index.js",
18025 "groupTitle": "Migrations"
18029 "url": "/api/voice/networks",
18030 "title": "Create a new network",
18033 "title": "Example usage:",
18034 "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18039 "group": "Networks",
18040 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18041 "version": "0.0.0",
18042 "filename": "server/api/network/index.js",
18043 "groupTitle": "Networks"
18047 "url": "/api/voice/networks/{id}",
18048 "title": "Deletes a network",
18051 "title": "Example usage:",
18052 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
18057 "group": "Networks",
18058 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18059 "version": "0.0.0",
18060 "filename": "server/api/network/index.js",
18061 "groupTitle": "Networks"
18065 "url": "/api/networks",
18066 "title": "Gets a list of Networks",
18069 "title": "Example usage:",
18070 "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
18074 "name": "GetNetworks",
18075 "group": "Networks",
18076 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18077 "version": "0.0.0",
18078 "filename": "server/api/network/index.js",
18079 "groupTitle": "Networks"
18083 "url": "/api/networks/{id}",
18084 "title": "Gets a single Network",
18087 "title": "Example usage:",
18088 "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
18092 "name": "ShowNetworks",
18093 "group": "Networks",
18094 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18095 "version": "0.0.0",
18096 "filename": "server/api/network/index.js",
18097 "groupTitle": "Networks"
18101 "url": "/api/voice/networks/{id}",
18102 "title": "Update an existing network",
18105 "title": "Example usage:",
18106 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
18111 "group": "Networks",
18112 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18113 "version": "0.0.0",
18114 "filename": "server/api/network/index.js",
18115 "groupTitle": "Networks"
18119 "url": "/api/openchannel/accounts/{id}/users",
18120 "title": "Add agents to a openchannel account",
18123 "title": "Example usage:",
18124 "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",
18128 "name": "AddAgents",
18129 "group": "Openchannel_Accounts",
18130 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18131 "version": "0.0.0",
18132 "filename": "server/api/openchannelAccount/index.js",
18133 "groupTitle": "Openchannel_Accounts"
18137 "url": "/api/openchannel/accounts",
18138 "title": "Creates a new Account",
18141 "title": "Example usage:",
18142 "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18146 "name": "CreateAccounts",
18147 "group": "Openchannel_Accounts",
18162 "field": "description",
18176 "field": "replyUri",
18190 "field": "notificationTemplate",
18197 "field": "notificationSound",
18204 "field": "notificationShake",
18211 "field": "waitForTheAssignedAgent",
18218 "field": "waitForTheAssignedQueue",
18232 "field": "queueTransfer",
18239 "field": "queueTransferTimeout",
18246 "field": "agentTransfer",
18253 "field": "agentTransferTimeout",
18260 "field": "mandatoryDispositionPauseId",
18261 "description": "<p>Status to put when mandatory disposition is enabled</p>"
18267 "field": "mandatoryDisposition",
18268 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
18273 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18274 "version": "0.0.0",
18275 "filename": "server/api/openchannelAccount/index.js",
18276 "groupTitle": "Openchannel_Accounts"
18280 "url": "/api/openchannel/accounts/{id}",
18281 "title": "Deletes a Account",
18284 "title": "Example usage:",
18285 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
18289 "name": "DeleteAccounts",
18290 "group": "Openchannel_Accounts",
18291 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18292 "version": "0.0.0",
18293 "filename": "server/api/openchannelAccount/index.js",
18294 "groupTitle": "Openchannel_Accounts"
18298 "url": "/api/openchannel/accounts/describe",
18299 "title": "Gets table info about Accounts",
18302 "title": "Example usage:",
18303 "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
18307 "name": "DescribeAccounts",
18308 "group": "Openchannel_Accounts",
18309 "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>",
18310 "version": "0.0.0",
18311 "filename": "server/api/openchannelAccount/index.js",
18312 "groupTitle": "Openchannel_Accounts"
18316 "url": "/api/openchannel/accounts",
18317 "title": "Gets a list of Accounts",
18320 "title": "Example usage:",
18321 "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
18325 "name": "GetAccounts",
18326 "group": "Openchannel_Accounts",
18327 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18328 "version": "0.0.0",
18329 "filename": "server/api/openchannelAccount/index.js",
18330 "groupTitle": "Openchannel_Accounts"
18334 "url": "/api/openchannel/accounts/{id}/users",
18335 "title": "Gets agents from openchannel account",
18338 "title": "Example usage:",
18339 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
18343 "name": "GetAgents",
18344 "group": "Openchannel_Accounts",
18345 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18346 "version": "0.0.0",
18347 "filename": "server/api/openchannelAccount/index.js",
18348 "groupTitle": "Openchannel_Accounts"
18352 "url": "/api/openchannel/accounts/{id}/users",
18353 "title": "Removes agents from a openchannel account",
18356 "title": "Example usage:",
18357 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18361 "name": "RemoveAgents",
18362 "group": "Openchannel_Accounts",
18363 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18364 "version": "0.0.0",
18365 "filename": "server/api/openchannelAccount/index.js",
18366 "groupTitle": "Openchannel_Accounts"
18370 "url": "/api/openchannel/accounts/{id}/canned_answers",
18371 "title": "Removes canned answers from account",
18374 "title": "Example usage:",
18375 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18379 "name": "RemoveAnswers",
18380 "group": "Openchannel_Accounts",
18381 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18382 "version": "0.0.0",
18383 "filename": "server/api/openchannelAccount/index.js",
18384 "groupTitle": "Openchannel_Accounts"
18388 "url": "/api/openchannel/accounts/{id}/dispositions",
18389 "title": "Removes dispositions from account",
18392 "title": "Example usage:",
18393 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18397 "name": "RemoveDispositions",
18398 "group": "Openchannel_Accounts",
18399 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18400 "version": "0.0.0",
18401 "filename": "server/api/openchannelAccount/index.js",
18402 "groupTitle": "Openchannel_Accounts"
18406 "url": "/api/openchannel/accounts/{id}",
18407 "title": "Gets a single Account",
18410 "title": "Example usage:",
18411 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
18415 "name": "ShowAccounts",
18416 "group": "Openchannel_Accounts",
18417 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18418 "version": "0.0.0",
18419 "filename": "server/api/openchannelAccount/index.js",
18420 "groupTitle": "Openchannel_Accounts"
18424 "url": "/api/openchannel/accounts/{id}/canned_answers",
18425 "title": "Creates new canned answer",
18428 "title": "Example usage:",
18429 "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",
18433 "name": "addAnswer",
18434 "group": "Openchannel_Accounts",
18456 "field": "description",
18469 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18470 "version": "0.0.0",
18471 "filename": "server/api/openchannelAccount/index.js",
18472 "groupTitle": "Openchannel_Accounts"
18476 "url": "/api/openchannel/accounts/{id}/applications",
18477 "title": "Creates new applications",
18480 "title": "Example usage:",
18481 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18485 "name": "addApplications",
18486 "group": "Openchannel_Accounts",
18494 "field": "priority",
18508 "field": "appdata",
18515 "field": "description",
18522 "field": "interval",
18528 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18529 "version": "0.0.0",
18530 "filename": "server/api/openchannelAccount/index.js",
18531 "groupTitle": "Openchannel_Accounts"
18535 "url": "/api/openchannel/accounts/{id}/dispositions",
18536 "title": "Creates new disposition",
18539 "title": "Example usage:",
18540 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18544 "name": "addDisposition",
18545 "group": "Openchannel_Accounts",
18572 "field": "description",
18578 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18579 "version": "0.0.0",
18580 "filename": "server/api/openchannelAccount/index.js",
18581 "groupTitle": "Openchannel_Accounts"
18585 "url": "/api/openchannel/accounts/{id}/canned_answers",
18586 "title": "Gets account canned answers",
18589 "title": "Example usage:",
18590 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
18594 "name": "getAnswers",
18595 "group": "Openchannel_Accounts",
18596 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18597 "version": "0.0.0",
18598 "filename": "server/api/openchannelAccount/index.js",
18599 "groupTitle": "Openchannel_Accounts"
18603 "url": "/api/openchannel/accounts/{id}/applications",
18604 "title": "Gets account applications",
18607 "title": "Example usage:",
18608 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
18612 "name": "getApplications",
18613 "group": "Openchannel_Accounts",
18614 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18615 "version": "0.0.0",
18616 "filename": "server/api/openchannelAccount/index.js",
18617 "groupTitle": "Openchannel_Accounts"
18621 "url": "/api/openchannel/accounts/{id}/dispositions",
18622 "title": "Gets account dispositions",
18625 "title": "Example usage:",
18626 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
18630 "name": "getDispositions",
18631 "group": "Openchannel_Accounts",
18632 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18633 "version": "0.0.0",
18634 "filename": "server/api/openchannelAccount/index.js",
18635 "groupTitle": "Openchannel_Accounts"
18639 "url": "/api/openchannel/accounts/{id}/interactions",
18640 "title": "Gets Openchannel Account Interactions",
18643 "title": "Example usage:",
18644 "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
18648 "name": "getInteractions",
18649 "group": "Openchannel_Accounts",
18650 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18651 "version": "0.0.0",
18652 "filename": "server/api/openchannelAccount/index.js",
18653 "groupTitle": "Openchannel_Accounts"
18657 "url": "/api/openchannel/accounts/{id}/notify",
18658 "title": "Notify new message",
18661 "title": "Example usage:",
18662 "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",
18667 "group": "Openchannel_Accounts",
18668 "description": "<p>Motion 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://xcally.atlassian.net/wiki/spaces/XMV/pages/1896252245/New+Channels+Configuration+Steps"</a></pre></p>",
18669 "version": "0.0.0",
18670 "filename": "server/api/openchannelAccount/index.js",
18671 "groupTitle": "Openchannel_Accounts"
18675 "url": "/api/openchannel/accounts/{id}/send",
18676 "title": "Send new openchannel message",
18679 "title": "Example usage:",
18680 "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",
18684 "name": "sendOpenchannel",
18685 "group": "Openchannel_Accounts",
18686 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18687 "version": "0.0.0",
18688 "filename": "server/api/openchannelAccount/index.js",
18689 "groupTitle": "Openchannel_Accounts"
18693 "url": "/api/openchannel/accounts/{id}",
18694 "title": "Update an existing Account",
18697 "title": "Example usage:",
18698 "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",
18702 "name": "updateAccounts",
18703 "group": "Openchannel_Accounts",
18704 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18705 "version": "0.0.0",
18706 "filename": "server/api/openchannelAccount/index.js",
18707 "groupTitle": "Openchannel_Accounts"
18711 "url": "/api/openchannel/applications",
18712 "title": "Creates a new Application",
18715 "title": "Example usage:",
18716 "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18720 "name": "CreateApplications",
18721 "group": "Openchannel_Applications",
18729 "field": "priority",
18743 "field": "appdata",
18750 "field": "description",
18757 "field": "interval",
18763 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18764 "version": "0.0.0",
18765 "filename": "server/api/openchannelApplication/index.js",
18766 "groupTitle": "Openchannel_Applications"
18770 "url": "/api/openchannel/applications/{id}",
18771 "title": "Deletes a Application",
18774 "title": "Example usage:",
18775 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
18779 "name": "DeleteApplications",
18780 "group": "Openchannel_Applications",
18781 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18782 "version": "0.0.0",
18783 "filename": "server/api/openchannelApplication/index.js",
18784 "groupTitle": "Openchannel_Applications"
18788 "url": "/api/openchannel/applications",
18789 "title": "Gets a list of Applications",
18792 "title": "Example usage:",
18793 "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
18797 "name": "GetApplications",
18798 "group": "Openchannel_Applications",
18799 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18800 "version": "0.0.0",
18801 "filename": "server/api/openchannelApplication/index.js",
18802 "groupTitle": "Openchannel_Applications"
18806 "url": "/api/openchannel/applications/{id}",
18807 "title": "Gets a single Application",
18810 "title": "Example usage:",
18811 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
18815 "name": "ShowApplications",
18816 "group": "Openchannel_Applications",
18817 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18818 "version": "0.0.0",
18819 "filename": "server/api/openchannelApplication/index.js",
18820 "groupTitle": "Openchannel_Applications"
18824 "url": "/api/openchannel/applications/{id}",
18825 "title": "Update an existing Application",
18828 "title": "Example usage:",
18829 "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",
18833 "name": "updateApplications",
18834 "group": "Openchannel_Applications",
18835 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18836 "version": "0.0.0",
18837 "filename": "server/api/openchannelApplication/index.js",
18838 "groupTitle": "Openchannel_Applications"
18842 "url": "/api/openchannel/interactions/{id}/tags",
18843 "title": "Add tags to the interaction",
18846 "title": "Example usage:",
18847 "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",
18852 "group": "Openchannel_Interactions",
18853 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18854 "version": "0.0.0",
18855 "filename": "server/api/openchannelInteraction/index.js",
18856 "groupTitle": "Openchannel_Interactions"
18860 "url": "/api/openchannel/interactions",
18861 "title": "Creates a new Interaction",
18864 "title": "Example usage:",
18865 "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18869 "name": "CreateInteractions",
18870 "group": "Openchannel_Interactions",
18885 "field": "closedAt",
18892 "field": "disposition",
18899 "field": "secondDisposition",
18906 "field": "thirdDisposition",
18920 "field": "read1stAt",
18927 "field": "threadId",
18934 "field": "externalUrl",
18941 "field": "lastMsgAt",
18952 "field": "lastMsgDirection",
18966 "field": "autoreplyExecuted",
18972 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18973 "version": "0.0.0",
18974 "filename": "server/api/openchannelInteraction/index.js",
18975 "groupTitle": "Openchannel_Interactions"
18979 "url": "/api/openchannel/interactions/{id}",
18980 "title": "Deletes a Interaction",
18983 "title": "Example usage:",
18984 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18988 "name": "DeleteInteractions",
18989 "group": "Openchannel_Interactions",
18990 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18991 "version": "0.0.0",
18992 "filename": "server/api/openchannelInteraction/index.js",
18993 "groupTitle": "Openchannel_Interactions"
18997 "url": "/api/openchannel/interactions/describe",
18998 "title": "Gets table info about Interactions",
19001 "title": "Example usage:",
19002 "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
19006 "name": "DescribeInteractions",
19007 "group": "Openchannel_Interactions",
19008 "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>",
19009 "version": "0.0.0",
19010 "filename": "server/api/openchannelInteraction/index.js",
19011 "groupTitle": "Openchannel_Interactions"
19015 "url": "/api/openchannel/interactions",
19016 "title": "Gets a list of Interactions",
19019 "title": "Example usage:",
19020 "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
19024 "name": "GetInteractions",
19025 "group": "Openchannel_Interactions",
19026 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19027 "version": "0.0.0",
19028 "filename": "server/api/openchannelInteraction/index.js",
19029 "groupTitle": "Openchannel_Interactions"
19033 "url": "/api/openchannel/interactions/{id}/tags",
19034 "title": "Removes tags from interaction",
19037 "title": "Example usage:",
19038 "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19042 "name": "RemoveTags",
19043 "group": "Openchannel_Interactions",
19044 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19045 "version": "0.0.0",
19046 "filename": "server/api/openchannelInteraction/index.js",
19047 "groupTitle": "Openchannel_Interactions"
19051 "url": "/api/openchannel/interactions/{id}",
19052 "title": "Gets a single Interaction",
19055 "title": "Example usage:",
19056 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
19060 "name": "ShowInteractions",
19061 "group": "Openchannel_Interactions",
19062 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19063 "version": "0.0.0",
19064 "filename": "server/api/openchannelInteraction/index.js",
19065 "groupTitle": "Openchannel_Interactions"
19069 "url": "/api/openchannel/interactions/{id}/messages",
19070 "title": "Creates new messages",
19073 "title": "Example usage:",
19074 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
19078 "name": "addMessage",
19079 "group": "Openchannel_Interactions",
19112 "field": "direction",
19126 "field": "providerName",
19133 "field": "providerResponse",
19139 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19140 "version": "0.0.0",
19141 "filename": "server/api/openchannelInteraction/index.js",
19142 "groupTitle": "Openchannel_Interactions"
19146 "url": "/api/openchannel/interactions/{id}/download",
19147 "title": "Gets interaction",
19150 "title": "Example usage:",
19151 "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
19155 "name": "download",
19156 "group": "Openchannel_Interactions",
19157 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19158 "version": "0.0.0",
19159 "filename": "server/api/openchannelInteraction/index.js",
19160 "groupTitle": "Openchannel_Interactions"
19164 "url": "/api/openchannel/interactions/{id}/messages",
19165 "title": "Gets interaction messages",
19168 "title": "Example usage:",
19169 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
19173 "name": "getMessages",
19174 "group": "Openchannel_Interactions",
19175 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19176 "version": "0.0.0",
19177 "filename": "server/api/openchannelInteraction/index.js",
19178 "groupTitle": "Openchannel_Interactions"
19182 "url": "/api/openchannel/interactions/{id}",
19183 "title": "Update an existing Interaction",
19186 "title": "Example usage:",
19187 "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",
19191 "name": "updateInteractions",
19192 "group": "Openchannel_Interactions",
19193 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19194 "version": "0.0.0",
19195 "filename": "server/api/openchannelInteraction/index.js",
19196 "groupTitle": "Openchannel_Interactions"
19200 "url": "/api/openchannel/messages",
19201 "title": "Creates a new Message",
19204 "title": "Example usage:",
19205 "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19209 "name": "CreateMessages",
19210 "group": "Openchannel_Messages",
19243 "field": "direction",
19257 "field": "providerName",
19264 "field": "providerResponse",
19270 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19271 "version": "0.0.0",
19272 "filename": "server/api/openchannelMessage/index.js",
19273 "groupTitle": "Openchannel_Messages"
19277 "url": "/api/openchannel/messages/{id}",
19278 "title": "Deletes a Message",
19281 "title": "Example usage:",
19282 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
19286 "name": "DeleteMessages",
19287 "group": "Openchannel_Messages",
19288 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19289 "version": "0.0.0",
19290 "filename": "server/api/openchannelMessage/index.js",
19291 "groupTitle": "Openchannel_Messages"
19295 "url": "/api/openchannel/messages/describe",
19296 "title": "Gets table info about Messages",
19299 "title": "Example usage:",
19300 "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
19304 "name": "DescribeMessages",
19305 "group": "Openchannel_Messages",
19306 "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>",
19307 "version": "0.0.0",
19308 "filename": "server/api/openchannelMessage/index.js",
19309 "groupTitle": "Openchannel_Messages"
19313 "url": "/api/openchannel/messages",
19314 "title": "Gets a list of Messages",
19317 "title": "Example usage:",
19318 "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
19322 "name": "GetMessages",
19323 "group": "Openchannel_Messages",
19324 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19325 "version": "0.0.0",
19326 "filename": "server/api/openchannelMessage/index.js",
19327 "groupTitle": "Openchannel_Messages"
19331 "url": "/api/openchannel/messages/{id}",
19332 "title": "Gets a single Message",
19335 "title": "Example usage:",
19336 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
19340 "name": "ShowMessages",
19341 "group": "Openchannel_Messages",
19342 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19343 "version": "0.0.0",
19344 "filename": "server/api/openchannelMessage/index.js",
19345 "groupTitle": "Openchannel_Messages"
19349 "url": "/api/openchannel/messages/{id}/accept",
19350 "title": "Accepts message",
19353 "title": "Example usage:",
19354 "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
19358 "name": "acceptMessage",
19359 "group": "Openchannel_Messages",
19360 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19361 "version": "0.0.0",
19362 "filename": "server/api/openchannelMessage/index.js",
19363 "groupTitle": "Openchannel_Messages"
19367 "url": "/api/openchannel/messages/{id}/reject",
19368 "title": "Rejects message",
19371 "title": "Example usage:",
19372 "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
19376 "name": "rejectMessage",
19377 "group": "Openchannel_Messages",
19378 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19379 "version": "0.0.0",
19380 "filename": "server/api/openchannelMessage/index.js",
19381 "groupTitle": "Openchannel_Messages"
19385 "url": "/api/openchannel/messages/{id}",
19386 "title": "Update an existing Message",
19389 "title": "Example usage:",
19390 "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",
19394 "name": "updateMessages",
19395 "group": "Openchannel_Messages",
19396 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19397 "version": "0.0.0",
19398 "filename": "server/api/openchannelMessage/index.js",
19399 "groupTitle": "Openchannel_Messages"
19403 "url": "/api/openchannel/reports/queue",
19404 "title": "Creates a new Openchannel Queue Report",
19407 "title": "Example usage:",
19408 "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",
19412 "name": "CreateOpenchannel_Queue_Reports",
19413 "group": "Openchannel_Queue_Reports",
19421 "field": "uniqueid",
19442 "field": "leaveAt",
19449 "field": "acceptAt",
19469 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19470 "version": "0.0.0",
19471 "filename": "server/api/openchannelQueueReport/index.js",
19472 "groupTitle": "Openchannel_Queue_Reports"
19476 "url": "/api/openchannel/reports/queue/{id}",
19477 "title": "Deletes a Openchannel Queue Report",
19480 "title": "Example usage:",
19481 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
19485 "name": "DeleteOpenchannel_Queue_Reports",
19486 "group": "Openchannel_Queue_Reports",
19487 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19488 "version": "0.0.0",
19489 "filename": "server/api/openchannelQueueReport/index.js",
19490 "groupTitle": "Openchannel_Queue_Reports"
19494 "url": "/api/openchannel/reports/queue/describe",
19495 "title": "Gets table info about Openchannel Queue Reports",
19498 "title": "Example usage:",
19499 "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
19503 "name": "DescribeOpenchannel_Queue_Reports",
19504 "group": "Openchannel_Queue_Reports",
19505 "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>",
19506 "version": "0.0.0",
19507 "filename": "server/api/openchannelQueueReport/index.js",
19508 "groupTitle": "Openchannel_Queue_Reports"
19512 "url": "/api/openchannel/reports/queue",
19513 "title": "Gets a list of Openchannel Queue Reports",
19516 "title": "Example usage:",
19517 "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
19521 "name": "GetOpenchannel_Queue_Reports",
19522 "group": "Openchannel_Queue_Reports",
19523 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19524 "version": "0.0.0",
19525 "filename": "server/api/openchannelQueueReport/index.js",
19526 "groupTitle": "Openchannel_Queue_Reports"
19530 "url": "/api/openchannel/reports/queue/{id}",
19531 "title": "Gets a single Openchannel Queue Report",
19534 "title": "Example usage:",
19535 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
19539 "name": "ShowOpenchannel_Queue_Reports",
19540 "group": "Openchannel_Queue_Reports",
19541 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19542 "version": "0.0.0",
19543 "filename": "server/api/openchannelQueueReport/index.js",
19544 "groupTitle": "Openchannel_Queue_Reports"
19548 "url": "/api/openchannel/reports/queue/{id}",
19549 "title": "Update an existing Openchannel Queue Report",
19552 "title": "Example usage:",
19553 "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",
19557 "name": "updateOpenchannel_Queue_Reports",
19558 "group": "Openchannel_Queue_Reports",
19559 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19560 "version": "0.0.0",
19561 "filename": "server/api/openchannelQueueReport/index.js",
19562 "groupTitle": "Openchannel_Queue_Reports"
19566 "url": "/api/openchannel/queues/{id}/users",
19567 "title": "Add agents to a queue",
19570 "title": "Example usage:",
19571 "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",
19575 "name": "AddAgents",
19576 "group": "Openchannel_Queues",
19577 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19578 "version": "0.0.0",
19579 "filename": "server/api/openchannelQueue/index.js",
19580 "groupTitle": "Openchannel_Queues"
19584 "url": "/api/openchannel/queues/{id}/teams",
19585 "title": "Add teams to a queue",
19588 "title": "Example usage:",
19589 "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",
19593 "name": "AddTeams",
19594 "group": "Openchannel_Queues",
19595 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19596 "version": "0.0.0",
19597 "filename": "server/api/openchannelQueue/index.js",
19598 "groupTitle": "Openchannel_Queues"
19602 "url": "/api/openchannel/queues",
19603 "title": "Creates a new Queue",
19606 "title": "Example usage:",
19607 "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19611 "name": "CreateQueues",
19612 "group": "Openchannel_Queues",
19627 "field": "description",
19634 "field": "timeout",
19646 "field": "strategy",
19652 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19653 "version": "0.0.0",
19654 "filename": "server/api/openchannelQueue/index.js",
19655 "groupTitle": "Openchannel_Queues"
19659 "url": "/api/openchannel/queues/{id}",
19660 "title": "Deletes a Queue",
19663 "title": "Example usage:",
19664 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
19668 "name": "DeleteQueues",
19669 "group": "Openchannel_Queues",
19670 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19671 "version": "0.0.0",
19672 "filename": "server/api/openchannelQueue/index.js",
19673 "groupTitle": "Openchannel_Queues"
19677 "url": "/api/openchannel/queues/describe",
19678 "title": "Gets table info about Queues",
19681 "title": "Example usage:",
19682 "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
19686 "name": "DescribeQueues",
19687 "group": "Openchannel_Queues",
19688 "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>",
19689 "version": "0.0.0",
19690 "filename": "server/api/openchannelQueue/index.js",
19691 "groupTitle": "Openchannel_Queues"
19695 "url": "/api/openchannel/queues/{id}/users",
19696 "title": "Gets queue agents",
19699 "title": "Example usage:",
19700 "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
19704 "name": "GetAgents",
19705 "group": "Openchannel_Queues",
19706 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19707 "version": "0.0.0",
19708 "filename": "server/api/openchannelQueue/index.js",
19709 "groupTitle": "Openchannel_Queues"
19713 "url": "/api/openchannel/queues/{id}/members",
19714 "title": "GetMembers",
19717 "title": "Example usage:",
19718 "content": "curl https://{domain}/api/openchannel/queues/{id}/members -v -u {name}:{password}",
19722 "name": "GetMembers",
19723 "group": "Openchannel_Queues",
19724 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19725 "version": "0.0.0",
19726 "filename": "server/api/openchannelQueue/index.js",
19727 "groupTitle": "Openchannel_Queues"
19731 "url": "/api/openchannel/queues",
19732 "title": "Gets a list of Queues",
19735 "title": "Example usage:",
19736 "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
19740 "name": "GetQueues",
19741 "group": "Openchannel_Queues",
19742 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19743 "version": "0.0.0",
19744 "filename": "server/api/openchannelQueue/index.js",
19745 "groupTitle": "Openchannel_Queues"
19749 "url": "/api/openchannel/queues/{id}/teams",
19750 "title": "Gets queues list",
19753 "title": "Example usage:",
19754 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
19758 "name": "GetTeams",
19759 "group": "Openchannel_Queues",
19760 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19761 "version": "0.0.0",
19762 "filename": "server/api/openchannelQueue/index.js",
19763 "groupTitle": "Openchannel_Queues"
19767 "url": "/api/openchannel/queues/{id}/users",
19768 "title": "Removes agents from a queue",
19771 "title": "Example usage:",
19772 "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19776 "name": "RemoveAgents",
19777 "group": "Openchannel_Queues",
19778 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19779 "version": "0.0.0",
19780 "filename": "server/api/openchannelQueue/index.js",
19781 "groupTitle": "Openchannel_Queues"
19785 "url": "/api/openchannel/queues/{id}",
19786 "title": "Gets a single Queue",
19789 "title": "Example usage:",
19790 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
19794 "name": "ShowQueues",
19795 "group": "Openchannel_Queues",
19796 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19797 "version": "0.0.0",
19798 "filename": "server/api/openchannelQueue/index.js",
19799 "groupTitle": "Openchannel_Queues"
19803 "url": "/api/openchannel/queues/{id}",
19804 "title": "Update an existing Queue",
19807 "title": "Example usage:",
19808 "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",
19812 "name": "updateQueues",
19813 "group": "Openchannel_Queues",
19814 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19815 "version": "0.0.0",
19816 "filename": "server/api/openchannelQueue/index.js",
19817 "groupTitle": "Openchannel_Queues"
19821 "url": "/api/openchannel/reports/transfer",
19822 "title": "Creates a new Openchannel Transfer Report",
19825 "title": "Example usage:",
19826 "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",
19830 "name": "CreateOpenchannel_Transfer_Reports",
19831 "group": "Openchannel_Transfer_Reports",
19839 "field": "uniqueid",
19858 "field": "transferredAt",
19864 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19865 "version": "0.0.0",
19866 "filename": "server/api/openchannelTransferReport/index.js",
19867 "groupTitle": "Openchannel_Transfer_Reports"
19871 "url": "/api/openchannel/reports/transfer/{id}",
19872 "title": "Deletes a Openchannel Transfer Report",
19875 "title": "Example usage:",
19876 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19880 "name": "DeleteOpenchannel_Transfer_Reports",
19881 "group": "Openchannel_Transfer_Reports",
19882 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19883 "version": "0.0.0",
19884 "filename": "server/api/openchannelTransferReport/index.js",
19885 "groupTitle": "Openchannel_Transfer_Reports"
19889 "url": "/api/openchannel/reports/transfer/describe",
19890 "title": "Gets table info about Openchannel Transfer Reports",
19893 "title": "Example usage:",
19894 "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19898 "name": "DescribeOpenchannel_Transfer_Reports",
19899 "group": "Openchannel_Transfer_Reports",
19900 "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>",
19901 "version": "0.0.0",
19902 "filename": "server/api/openchannelTransferReport/index.js",
19903 "groupTitle": "Openchannel_Transfer_Reports"
19907 "url": "/api/openchannel/reports/transfer",
19908 "title": "Gets a list of Openchannel Transfer Reports",
19911 "title": "Example usage:",
19912 "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19916 "name": "GetOpenchannel_Transfer_Reports",
19917 "group": "Openchannel_Transfer_Reports",
19918 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19919 "version": "0.0.0",
19920 "filename": "server/api/openchannelTransferReport/index.js",
19921 "groupTitle": "Openchannel_Transfer_Reports"
19925 "url": "/api/openchannel/reports/transfer/{id}",
19926 "title": "Gets a single Openchannel Transfer Report",
19929 "title": "Example usage:",
19930 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19934 "name": "ShowOpenchannel_Transfer_Reports",
19935 "group": "Openchannel_Transfer_Reports",
19936 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19937 "version": "0.0.0",
19938 "filename": "server/api/openchannelTransferReport/index.js",
19939 "groupTitle": "Openchannel_Transfer_Reports"
19943 "url": "/api/openchannel/reports/transfer/{id}",
19944 "title": "Update an existing Openchannel Transfer Report",
19947 "title": "Example usage:",
19948 "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",
19952 "name": "updateOpenchannel_Transfer_Reports",
19953 "group": "Openchannel_Transfer_Reports",
19954 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19955 "version": "0.0.0",
19956 "filename": "server/api/openchannelTransferReport/index.js",
19957 "groupTitle": "Openchannel_Transfer_Reports"
19961 "url": "/api/pauses",
19962 "title": "Creates a new Pause",
19965 "title": "Example usage:",
19966 "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19970 "name": "CreatePauses",
19986 "field": "description",
19992 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19993 "version": "0.0.0",
19994 "filename": "server/api/pause/index.js",
19995 "groupTitle": "Pauses"
19999 "url": "/api/pauses/{id}",
20000 "title": "Deletes a Pause",
20003 "title": "Example usage:",
20004 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
20008 "name": "DeletePauses",
20010 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20011 "version": "0.0.0",
20012 "filename": "server/api/pause/index.js",
20013 "groupTitle": "Pauses"
20017 "url": "/api/pauses",
20018 "title": "Gets a list of Pauses",
20021 "title": "Example usage:",
20022 "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
20026 "name": "GetPauses",
20028 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20029 "version": "0.0.0",
20030 "filename": "server/api/pause/index.js",
20031 "groupTitle": "Pauses"
20035 "url": "/api/pauses/{id}",
20036 "title": "Gets a single Pause",
20039 "title": "Example usage:",
20040 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
20044 "name": "ShowPauses",
20046 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20047 "version": "0.0.0",
20048 "filename": "server/api/pause/index.js",
20049 "groupTitle": "Pauses"
20053 "url": "/api/pauses/{id}",
20054 "title": "Update an existing Pause",
20057 "title": "Example usage:",
20058 "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20062 "name": "updatePauses",
20064 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20065 "version": "0.0.0",
20066 "filename": "server/api/pause/index.js",
20067 "groupTitle": "Pauses"
20071 "url": "/api/plugins",
20072 "title": "Gets a list of Plugins",
20075 "title": "Example usage:",
20076 "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
20080 "name": "GetPlugins",
20081 "group": "Plugins",
20082 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20083 "version": "0.0.0",
20084 "filename": "server/api/plugin/index.js",
20085 "groupTitle": "Plugins"
20089 "url": "/api/plugins/{id}",
20090 "title": "Gets a single Plugin",
20093 "title": "Example usage:",
20094 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
20098 "name": "ShowPlugins",
20099 "group": "Plugins",
20100 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20101 "version": "0.0.0",
20102 "filename": "server/api/plugin/index.js",
20103 "groupTitle": "Plugins"
20107 "url": "/api/plugins/{id}",
20108 "title": "Delete a plugin",
20111 "title": "Example usage:",
20112 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
20116 "name": "destroyPlugin",
20117 "group": "Plugins",
20118 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20119 "version": "0.0.0",
20120 "filename": "server/api/plugin/index.js",
20121 "groupTitle": "Plugins"
20125 "url": "/api/plugins/{id}/download",
20126 "title": "Download plugin source code",
20129 "title": "Example usage:",
20130 "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
20134 "name": "download",
20135 "group": "Plugins",
20136 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20137 "version": "0.0.0",
20138 "filename": "server/api/plugin/index.js",
20139 "groupTitle": "Plugins"
20143 "url": "/api/plugins/{id}",
20144 "title": "Update an existing plugin",
20147 "title": "Example usage:",
20148 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
20152 "name": "updatePlugin",
20153 "group": "Plugins",
20154 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20155 "version": "0.0.0",
20156 "filename": "server/api/plugin/index.js",
20157 "groupTitle": "Plugins"
20161 "url": "/api/plugins",
20162 "title": "Upload new plugin",
20165 "title": "Example usage:",
20166 "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
20170 "name": "uploadPlugin",
20171 "group": "Plugins",
20172 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20173 "version": "0.0.0",
20174 "filename": "server/api/plugin/index.js",
20175 "groupTitle": "Plugins"
20179 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
20180 "title": "Redirect a plugin request to the specified path",
20183 "title": "Example usage:",
20184 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
20188 "name": "webhookPlugin",
20189 "group": "Plugins",
20190 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20191 "version": "0.0.0",
20192 "filename": "server/api/plugin/index.js",
20193 "groupTitle": "Plugins"
20197 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
20198 "title": "Redirect a plugin request to the specified path",
20201 "title": "Example usage:",
20202 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
20206 "name": "webhookPlugin",
20207 "group": "Plugins",
20208 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20209 "version": "0.0.0",
20210 "filename": "server/api/plugin/index.js",
20211 "groupTitle": "Plugins"
20215 "url": "/api/pm2/{id}",
20216 "title": "Deletes an existing process",
20219 "title": "Example usage:",
20220 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
20224 "name": "DeletePm2Process",
20226 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20227 "version": "0.0.0",
20228 "filename": "server/api/pm2/index.js",
20229 "groupTitle": "Pm2"
20233 "url": "/api/pm2/{id}",
20234 "title": "Gets a single pm2 process",
20237 "title": "Example usage:",
20238 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
20242 "name": "GetPm2Process",
20244 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20245 "version": "0.0.0",
20246 "filename": "server/api/pm2/index.js",
20247 "groupTitle": "Pm2"
20252 "title": "Gets pm2 processes",
20255 "title": "Example usage:",
20256 "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
20260 "name": "GetPm2Processes",
20262 "description": "<p>Motion returns the pm2 processes list.</p>",
20263 "version": "0.0.0",
20264 "filename": "server/api/pm2/index.js",
20265 "groupTitle": "Pm2"
20270 "title": "Start a single pm2 process",
20273 "title": "Example usage:",
20274 "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",
20278 "name": "StartPm2Process",
20300 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20301 "version": "0.0.0",
20302 "filename": "server/api/pm2/index.js",
20303 "groupTitle": "Pm2"
20307 "url": "/api/pm2/{id}",
20308 "title": "Update an existing process",
20311 "title": "Example usage:",
20312 "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20316 "name": "UpdatePm2Process",
20318 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20319 "version": "0.0.0",
20320 "filename": "server/api/pm2/index.js",
20321 "groupTitle": "Pm2"
20325 "url": "/api/rpc/campaigns/",
20326 "title": "Gets a list of campaigns",
20329 "title": "Example usage:",
20330 "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
20334 "name": "Campaigns",
20335 "group": "RPC_Realtime",
20336 "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>",
20337 "version": "0.0.0",
20338 "filename": "server/api/rpc/index.js",
20339 "groupTitle": "RPC_Realtime"
20343 "url": "/api/rpc/fax/accounts",
20344 "title": "Gets a list of FaxAccounts",
20347 "title": "Example usage:",
20348 "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
20352 "name": "FaxAccounts",
20353 "group": "RPC_Realtime",
20354 "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>",
20355 "version": "0.0.0",
20356 "filename": "server/api/rpc/index.js",
20357 "groupTitle": "RPC_Realtime"
20361 "url": "/api/rpc/agents/:id/capacity",
20362 "title": "Sets agent capacity",
20365 "title": "Example usage:",
20366 "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
20370 "name": "RTAgentCapacity",
20371 "group": "RPC_Realtime",
20372 "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>",
20373 "version": "0.0.0",
20374 "filename": "server/api/rpc/index.js",
20375 "groupTitle": "RPC_Realtime"
20379 "url": "/api/rpc/agents",
20380 "title": "Gets a list of RTAgents",
20383 "title": "Example usage:",
20384 "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
20388 "name": "RTAgents",
20389 "group": "RPC_Realtime",
20390 "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>",
20391 "version": "0.0.0",
20392 "filename": "server/api/rpc/index.js",
20393 "groupTitle": "RPC_Realtime"
20397 "url": "/api/rpc/chat/queues",
20398 "title": "Gets a list of RTChatQueues",
20401 "title": "Example usage:",
20402 "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
20406 "name": "RTChatQueues",
20407 "group": "RPC_Realtime",
20408 "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>",
20409 "version": "0.0.0",
20410 "filename": "server/api/rpc/index.js",
20411 "groupTitle": "RPC_Realtime"
20415 "url": "/api/rpc/fax/queues",
20416 "title": "Gets a list of RTFaxQueues",
20419 "title": "Example usage:",
20420 "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
20424 "name": "RTFaxQueues",
20425 "group": "RPC_Realtime",
20426 "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>",
20427 "version": "0.0.0",
20428 "filename": "server/api/rpc/index.js",
20429 "groupTitle": "RPC_Realtime"
20433 "url": "/api/rpc/mail/accounts",
20434 "title": "Gets a list of RTMailAccounts",
20437 "title": "Example usage:",
20438 "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
20442 "name": "RTMailAccounts",
20443 "group": "RPC_Realtime",
20444 "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>",
20445 "version": "0.0.0",
20446 "filename": "server/api/rpc/index.js",
20447 "groupTitle": "RPC_Realtime"
20451 "url": "/api/rpc/mail/queues",
20452 "title": "Gets a list of RTMailQueues",
20455 "title": "Example usage:",
20456 "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
20460 "name": "RTMailQueues",
20461 "group": "RPC_Realtime",
20462 "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>",
20463 "version": "0.0.0",
20464 "filename": "server/api/rpc/index.js",
20465 "groupTitle": "RPC_Realtime"
20469 "url": "/api/rpc/openchannel/queues",
20470 "title": "Gets a list of RTOpenchannelQueues",
20473 "title": "Example usage:",
20474 "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
20478 "name": "RTOpenchannelQueues",
20479 "group": "RPC_Realtime",
20480 "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>",
20481 "version": "0.0.0",
20482 "filename": "server/api/rpc/index.js",
20483 "groupTitle": "RPC_Realtime"
20487 "url": "/api/rpc/outbound/channels",
20488 "title": "Gets a list of RTOutboundChannels",
20491 "title": "Example usage:",
20492 "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
20496 "name": "RTOutboundChannels",
20497 "group": "RPC_Realtime",
20498 "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>",
20499 "version": "0.0.0",
20500 "filename": "server/api/rpc/index.js",
20501 "groupTitle": "RPC_Realtime"
20505 "url": "/api/rpc/sms/queues",
20506 "title": "Gets a list of RTSmsQueues",
20509 "title": "Example usage:",
20510 "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
20514 "name": "RTSmsQueues",
20515 "group": "RPC_Realtime",
20516 "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>",
20517 "version": "0.0.0",
20518 "filename": "server/api/rpc/index.js",
20519 "groupTitle": "RPC_Realtime"
20523 "url": "/api/rpc/telephones",
20524 "title": "Gets a list of RTTelephones",
20527 "title": "Example usage:",
20528 "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
20532 "name": "RTTelephones",
20533 "group": "RPC_Realtime",
20534 "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>",
20535 "version": "0.0.0",
20536 "filename": "server/api/rpc/index.js",
20537 "groupTitle": "RPC_Realtime"
20541 "url": "/api/rpc/trunks",
20542 "title": "Gets a list of RTTrunks",
20545 "title": "Example usage:",
20546 "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
20550 "name": "RTTrunks",
20551 "group": "RPC_Realtime",
20552 "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>",
20553 "version": "0.0.0",
20554 "filename": "server/api/rpc/index.js",
20555 "groupTitle": "RPC_Realtime"
20559 "url": "/api/rpc/voice/channels",
20560 "title": "Gets a list of RTVoiceChannelMixMonitor",
20563 "title": "Example usage:",
20564 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
20568 "name": "RTVoiceChannelMixMonitor",
20569 "group": "RPC_Realtime",
20570 "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>",
20571 "version": "0.0.0",
20572 "filename": "server/api/rpc/index.js",
20573 "groupTitle": "RPC_Realtime"
20577 "url": "/api/rpc/voice/channels",
20578 "title": "Gets a list of RTVoiceChannelStopMixMonitor",
20581 "title": "Example usage:",
20582 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
20586 "name": "RTVoiceChannelStopMixMonitor",
20587 "group": "RPC_Realtime",
20588 "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>",
20589 "version": "0.0.0",
20590 "filename": "server/api/rpc/index.js",
20591 "groupTitle": "RPC_Realtime"
20595 "url": "/api/rpc/voice/channels",
20596 "title": "Gets a list of RTVoiceChannels",
20599 "title": "Example usage:",
20600 "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
20604 "name": "RTVoiceChannels",
20605 "group": "RPC_Realtime",
20606 "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>",
20607 "version": "0.0.0",
20608 "filename": "server/api/rpc/index.js",
20609 "groupTitle": "RPC_Realtime"
20613 "url": "/api/rpc/voice/queues/channels/{uniqueid}",
20614 "title": "Gets a single RTVoiceQueueChannel",
20617 "title": "Example usage:",
20618 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
20622 "name": "RTVoiceQueueChannel",
20623 "group": "RPC_Realtime",
20624 "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20625 "version": "0.0.0",
20626 "filename": "server/api/rpc/index.js",
20627 "groupTitle": "RPC_Realtime"
20631 "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
20632 "title": "Hangup a single RTVoiceQueueChannel",
20635 "title": "Example usage:",
20636 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
20640 "name": "RTVoiceQueueChannelHangup",
20641 "group": "RPC_Realtime",
20642 "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20643 "version": "0.0.0",
20644 "filename": "server/api/rpc/index.js",
20645 "groupTitle": "RPC_Realtime"
20649 "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
20650 "title": "Hangup a single RTVoiceQueueChannel",
20653 "title": "Example usage:",
20654 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
20658 "name": "RTVoiceQueueChannelRedirect",
20659 "group": "RPC_Realtime",
20660 "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>",
20661 "version": "0.0.0",
20662 "filename": "server/api/rpc/index.js",
20663 "groupTitle": "RPC_Realtime"
20667 "url": "/api/rpc/voice/queues/preview/{id}",
20668 "title": "Gets a single preview contact",
20671 "title": "Example usage:",
20672 "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
20676 "name": "RTVoiceQueuePreview",
20677 "group": "RPC_Realtime",
20678 "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20679 "version": "0.0.0",
20680 "filename": "server/api/rpc/index.js",
20681 "groupTitle": "RPC_Realtime"
20685 "url": "/api/rpc/voice/queues",
20686 "title": "Gets a list of RTVoiceQueues",
20689 "title": "Example usage:",
20690 "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
20694 "name": "RTVoiceQueues",
20695 "group": "RPC_Realtime",
20696 "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>",
20697 "version": "0.0.0",
20698 "filename": "server/api/rpc/index.js",
20699 "groupTitle": "RPC_Realtime"
20703 "url": "/api/rpc/outbound",
20704 "title": "Gets a list of RTOutbound",
20707 "title": "Example usage:",
20708 "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
20712 "name": "RTVoiceQueues",
20713 "group": "RPC_Realtime",
20714 "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>",
20715 "version": "0.0.0",
20716 "filename": "server/api/rpc/index.js",
20717 "groupTitle": "RPC_Realtime"
20721 "url": "/api/rpc/voice/queues/channels",
20722 "title": "Gets a list of RTVoiceQueuesChannels",
20725 "title": "Example usage:",
20726 "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
20730 "name": "RTVoiceQueuesChannels",
20731 "group": "RPC_Realtime",
20732 "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>",
20733 "version": "0.0.0",
20734 "filename": "server/api/rpc/index.js",
20735 "groupTitle": "RPC_Realtime"
20739 "url": "/api/rpc/chat/queues/{id}",
20740 "title": "Gets a single RTChatQueue",
20743 "title": "Example usage:",
20744 "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
20748 "name": "ShowRTChatQueues",
20749 "group": "RPC_Realtime",
20750 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20751 "version": "0.0.0",
20752 "filename": "server/api/rpc/index.js",
20753 "groupTitle": "RPC_Realtime"
20757 "url": "/api/rpc/fax/queues/{id}",
20758 "title": "Gets a single RTFaxQueue",
20761 "title": "Example usage:",
20762 "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
20766 "name": "ShowRTFaxQueues",
20767 "group": "RPC_Realtime",
20768 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20769 "version": "0.0.0",
20770 "filename": "server/api/rpc/index.js",
20771 "groupTitle": "RPC_Realtime"
20775 "url": "/api/rpc/mail/queues/{id}",
20776 "title": "Gets a single RTMailQueue",
20779 "title": "Example usage:",
20780 "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
20784 "name": "ShowRTMailQueues",
20785 "group": "RPC_Realtime",
20786 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20787 "version": "0.0.0",
20788 "filename": "server/api/rpc/index.js",
20789 "groupTitle": "RPC_Realtime"
20793 "url": "/api/rpc/openchannel/queues/{id}",
20794 "title": "Gets a single RTOpenchannelQueue",
20797 "title": "Example usage:",
20798 "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
20802 "name": "ShowRTOpenchannelQueues",
20803 "group": "RPC_Realtime",
20804 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20805 "version": "0.0.0",
20806 "filename": "server/api/rpc/index.js",
20807 "groupTitle": "RPC_Realtime"
20811 "url": "/api/rpc/sms/queues/{id}",
20812 "title": "Gets a single RTSmsQueue",
20815 "title": "Example usage:",
20816 "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
20820 "name": "ShowRTSmsQueues",
20821 "group": "RPC_Realtime",
20822 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20823 "version": "0.0.0",
20824 "filename": "server/api/rpc/index.js",
20825 "groupTitle": "RPC_Realtime"
20829 "url": "/api/rpc/voice/queues/{id}",
20830 "title": "Gets a single RTVoiceQueue",
20833 "title": "Example usage:",
20834 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20838 "name": "ShowRTVoiceQueues",
20839 "group": "RPC_Realtime",
20840 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20841 "version": "0.0.0",
20842 "filename": "server/api/rpc/index.js",
20843 "groupTitle": "RPC_Realtime"
20847 "url": "/api/rpc/voice/{id}/queues",
20848 "title": "Updates a single VoiceQueue",
20851 "title": "Example usage:",
20852 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20856 "name": "UpdateVoiceQueues",
20857 "group": "RPC_Realtime",
20858 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20859 "version": "0.0.0",
20860 "filename": "server/api/rpc/index.js",
20861 "groupTitle": "RPC_Realtime"
20865 "url": "/api/rpc/agents/:id/notify",
20866 "title": "Notify message to a specific agent",
20869 "title": "Example usage:",
20870 "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",
20874 "name": "agentNotify",
20875 "group": "RPC_Realtime",
20876 "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>",
20877 "version": "0.0.0",
20878 "filename": "server/api/rpc/index.js",
20879 "groupTitle": "RPC_Realtime"
20883 "url": "/api/rpc/chat/queues/:id/notify",
20884 "title": "Notify message to a specific queue",
20887 "title": "Example usage:",
20888 "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",
20892 "name": "chatQueueNotify",
20893 "group": "RPC_Realtime",
20894 "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>",
20895 "version": "0.0.0",
20896 "filename": "server/api/rpc/index.js",
20897 "groupTitle": "RPC_Realtime"
20901 "url": "/api/rpc/chat/queues/waitinginteractions",
20902 "title": "Gets a list of chatQueuesWaitingInteractions",
20905 "title": "Example usage:",
20906 "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20910 "name": "chatQueuesWaitingInteractions",
20911 "group": "RPC_Realtime",
20912 "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>",
20913 "version": "0.0.0",
20914 "filename": "server/api/rpc/index.js",
20915 "groupTitle": "RPC_Realtime"
20919 "url": "/api/rpc/fax/queues/:id/notify",
20920 "title": "Notify message to a specific queue",
20923 "title": "Example usage:",
20924 "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",
20928 "name": "faxQueueNotify",
20929 "group": "RPC_Realtime",
20930 "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>",
20931 "version": "0.0.0",
20932 "filename": "server/api/rpc/index.js",
20933 "groupTitle": "RPC_Realtime"
20937 "url": "/api/rpc/fax/queues/waitinginteractions",
20938 "title": "Gets a list of faxQueuesWaitingInteractions",
20941 "title": "Example usage:",
20942 "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20946 "name": "faxQueuesWaitingInteractions",
20947 "group": "RPC_Realtime",
20948 "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>",
20949 "version": "0.0.0",
20950 "filename": "server/api/rpc/index.js",
20951 "groupTitle": "RPC_Realtime"
20955 "url": "/api/rpc/mail/queues/:id/notify",
20956 "title": "Notify message to a specific queue",
20959 "title": "Example usage:",
20960 "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",
20964 "name": "mailQueueNotify",
20965 "group": "RPC_Realtime",
20966 "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20967 "version": "0.0.0",
20968 "filename": "server/api/rpc/index.js",
20969 "groupTitle": "RPC_Realtime"
20973 "url": "/api/rpc/mail/queues/waitinginteractions",
20974 "title": "Gets a list of mailQueuesWaitingInteractions",
20977 "title": "Example usage:",
20978 "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20982 "name": "mailQueuesWaitingInteractions",
20983 "group": "RPC_Realtime",
20984 "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>",
20985 "version": "0.0.0",
20986 "filename": "server/api/rpc/index.js",
20987 "groupTitle": "RPC_Realtime"
20991 "url": "/api/rpc/openchannel/queues/:id/notify",
20992 "title": "Notify message to a specific queue",
20995 "title": "Example usage:",
20996 "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",
21000 "name": "openchannelQueueNotify",
21001 "group": "RPC_Realtime",
21002 "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>",
21003 "version": "0.0.0",
21004 "filename": "server/api/rpc/index.js",
21005 "groupTitle": "RPC_Realtime"
21009 "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
21010 "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
21013 "title": "Example usage:",
21014 "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
21018 "name": "openchannelQueuesIdWaitingInteractions",
21019 "group": "RPC_Realtime",
21020 "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>",
21021 "version": "0.0.0",
21022 "filename": "server/api/rpc/index.js",
21023 "groupTitle": "RPC_Realtime"
21027 "url": "/api/rpc/openchannel/queues/waitinginteractions",
21028 "title": "Gets a list of openchannelQueuesWaitingInteractions",
21031 "title": "Example usage:",
21032 "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
21036 "name": "openchannelQueuesWaitingInteractions",
21037 "group": "RPC_Realtime",
21038 "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>",
21039 "version": "0.0.0",
21040 "filename": "server/api/rpc/index.js",
21041 "groupTitle": "RPC_Realtime"
21045 "url": "/api/rpc/sms/queues/:id/notify",
21046 "title": "Notify message to a specific queue",
21049 "title": "Example usage:",
21050 "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",
21054 "name": "smsQueueNotify",
21055 "group": "RPC_Realtime",
21056 "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>",
21057 "version": "0.0.0",
21058 "filename": "server/api/rpc/index.js",
21059 "groupTitle": "RPC_Realtime"
21063 "url": "/api/rpc/sms/queues/waitinginteractions",
21064 "title": "Gets a list of smsQueuesWaitingInteractions",
21067 "title": "Example usage:",
21068 "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
21072 "name": "smsQueuesWaitingInteractions",
21073 "group": "RPC_Realtime",
21074 "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>",
21075 "version": "0.0.0",
21076 "filename": "server/api/rpc/index.js",
21077 "groupTitle": "RPC_Realtime"
21081 "url": "/api/realtime/agents",
21082 "title": "Gets realtime agents info",
21085 "title": "Example usage:",
21086 "content": "curl https://{domain}/api/realtime/agents -v -u {name}:{password} -X GET",
21090 "name": "getAgents",
21091 "group": "Realtime",
21092 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21093 "version": "0.0.0",
21094 "filename": "server/api/realtime/index.js",
21095 "groupTitle": "Realtime"
21099 "url": "/api/realtime/queues",
21100 "title": "Gets realtime queues info",
21103 "title": "Example usage:",
21104 "content": "curl https://{domain}/api/realtime/queues -v -u {name}:{password} -X GET",
21108 "name": "getQueues",
21109 "group": "Realtime",
21110 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21111 "version": "0.0.0",
21112 "filename": "server/api/realtime/index.js",
21113 "groupTitle": "Realtime"
21117 "url": "/api/integrations/salesforce/accounts",
21118 "title": "Creates a new Salesforce Account",
21121 "title": "Example usage:",
21122 "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",
21126 "name": "CreateSalesforce_Accounts",
21127 "group": "Salesforce_Accounts",
21142 "field": "description",
21149 "field": "username",
21156 "field": "remoteUri",
21163 "field": "password",
21170 "field": "clientId",
21177 "field": "clientSecret",
21184 "field": "securityToken",
21191 "field": "serverUrl",
21198 "\"integrationTab\"",
21208 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21209 "version": "0.0.0",
21210 "filename": "server/api/intSalesforceAccount/index.js",
21211 "groupTitle": "Salesforce_Accounts"
21215 "url": "/api/integrations/salesforce/accounts/{id}",
21216 "title": "Deletes a Salesforce Account",
21219 "title": "Example usage:",
21220 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
21224 "name": "DeleteSalesforce_Accounts",
21225 "group": "Salesforce_Accounts",
21226 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21227 "version": "0.0.0",
21228 "filename": "server/api/intSalesforceAccount/index.js",
21229 "groupTitle": "Salesforce_Accounts"
21233 "url": "/api/integrations/salesforce/accounts",
21234 "title": "Gets a list of Salesforce Accounts",
21237 "title": "Example usage:",
21238 "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
21242 "name": "GetSalesforce_Accounts",
21243 "group": "Salesforce_Accounts",
21244 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21245 "version": "0.0.0",
21246 "filename": "server/api/intSalesforceAccount/index.js",
21247 "groupTitle": "Salesforce_Accounts"
21251 "url": "/api/integrations/salesforce/accounts/{id}",
21252 "title": "Gets a single Salesforce Account",
21255 "title": "Example usage:",
21256 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
21260 "name": "ShowSalesforce_Accounts",
21261 "group": "Salesforce_Accounts",
21262 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21263 "version": "0.0.0",
21264 "filename": "server/api/intSalesforceAccount/index.js",
21265 "groupTitle": "Salesforce_Accounts"
21269 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
21270 "title": "Creates new configuration",
21273 "title": "Example usage:",
21274 "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",
21278 "name": "addConfiguration",
21279 "group": "Salesforce_Accounts",
21280 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21281 "version": "0.0.0",
21282 "filename": "server/api/intSalesforceAccount/index.js",
21283 "groupTitle": "Salesforce_Accounts"
21287 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
21288 "title": "Gets account configurations",
21291 "title": "Example usage:",
21292 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21296 "name": "getConfigurations",
21297 "group": "Salesforce_Accounts",
21298 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21299 "version": "0.0.0",
21300 "filename": "server/api/intSalesforceAccount/index.js",
21301 "groupTitle": "Salesforce_Accounts"
21305 "url": "/api/integrations/salesforce/accounts/{id}/fields",
21306 "title": "Gets account fields",
21309 "title": "Example usage:",
21310 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
21314 "name": "getFields",
21315 "group": "Salesforce_Accounts",
21316 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21317 "version": "0.0.0",
21318 "filename": "server/api/intSalesforceAccount/index.js",
21319 "groupTitle": "Salesforce_Accounts"
21323 "url": "/api/integrations/salesforce/accounts/{id}",
21324 "title": "Update an existing Salesforce Account",
21327 "title": "Example usage:",
21328 "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",
21332 "name": "updateSalesforce_Accounts",
21333 "group": "Salesforce_Accounts",
21334 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21335 "version": "0.0.0",
21336 "filename": "server/api/intSalesforceAccount/index.js",
21337 "groupTitle": "Salesforce_Accounts"
21341 "url": "/api/integrations/salesforce/configurations",
21342 "title": "Creates a new Salesforce Configuration",
21345 "title": "Example usage:",
21346 "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",
21350 "name": "CreateSalesforce_Configurations",
21351 "group": "Salesforce_Configurations",
21366 "field": "description",
21377 "field": "ticketType",
21384 "\"contact_lead\"",
21387 "\"account_contact_lead\"",
21391 "field": "moduleSearch",
21404 "field": "moduleCreate",
21418 "field": "additionalSearchAccount",
21425 "field": "additionalSearchContact",
21432 "field": "additionalSearchLead",
21438 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21439 "version": "0.0.0",
21440 "filename": "server/api/intSalesforceConfiguration/index.js",
21441 "groupTitle": "Salesforce_Configurations"
21445 "url": "/api/integrations/salesforce/configurations/{id}",
21446 "title": "Deletes a Salesforce Configuration",
21449 "title": "Example usage:",
21450 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
21454 "name": "DeleteSalesforce_Configurations",
21455 "group": "Salesforce_Configurations",
21456 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21457 "version": "0.0.0",
21458 "filename": "server/api/intSalesforceConfiguration/index.js",
21459 "groupTitle": "Salesforce_Configurations"
21463 "url": "/api/integrations/salesforce/configurations",
21464 "title": "Gets a list of Salesforce Configurations",
21467 "title": "Example usage:",
21468 "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
21472 "name": "GetSalesforce_Configurations",
21473 "group": "Salesforce_Configurations",
21474 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21475 "version": "0.0.0",
21476 "filename": "server/api/intSalesforceConfiguration/index.js",
21477 "groupTitle": "Salesforce_Configurations"
21481 "url": "/api/integrations/salesforce/configurations/{id}",
21482 "title": "Gets a single Salesforce Configuration",
21485 "title": "Example usage:",
21486 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
21490 "name": "ShowSalesforce_Configurations",
21491 "group": "Salesforce_Configurations",
21492 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21493 "version": "0.0.0",
21494 "filename": "server/api/intSalesforceConfiguration/index.js",
21495 "groupTitle": "Salesforce_Configurations"
21499 "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
21500 "title": "Gets configurations descriptions",
21503 "title": "Example usage:",
21504 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21508 "name": "getDescriptions",
21509 "group": "Salesforce_Configurations",
21510 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21511 "version": "0.0.0",
21512 "filename": "server/api/intSalesforceConfiguration/index.js",
21513 "groupTitle": "Salesforce_Configurations"
21517 "url": "/api/integrations/salesforce/configurations/{id}/fields",
21518 "title": "Gets configurations fields",
21521 "title": "Example usage:",
21522 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
21526 "name": "getFields",
21527 "group": "Salesforce_Configurations",
21528 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21529 "version": "0.0.0",
21530 "filename": "server/api/intSalesforceConfiguration/index.js",
21531 "groupTitle": "Salesforce_Configurations"
21535 "url": "/api/integrations/salesforce/configurations/{id}/subjects",
21536 "title": "Gets configurations subjects",
21539 "title": "Example usage:",
21540 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21544 "name": "getSubjects",
21545 "group": "Salesforce_Configurations",
21546 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21547 "version": "0.0.0",
21548 "filename": "server/api/intSalesforceConfiguration/index.js",
21549 "groupTitle": "Salesforce_Configurations"
21553 "url": "/api/integrations/salesforce/configurations/{id}",
21554 "title": "Update an existing Salesforce Configuration",
21557 "title": "Example usage:",
21558 "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",
21562 "name": "updateSalesforce_Configurations",
21563 "group": "Salesforce_Configurations",
21564 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21565 "version": "0.0.0",
21566 "filename": "server/api/intSalesforceConfiguration/index.js",
21567 "groupTitle": "Salesforce_Configurations"
21571 "url": "/api/integrations/salesforce/fields",
21572 "title": "Creates a new Salesforce Field",
21575 "title": "Example usage:",
21576 "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",
21580 "name": "CreateSalesforce_Fields",
21581 "group": "Salesforce_Fields",
21591 "\"customVariable\"",
21603 "field": "content",
21619 "\"customVariable\""
21622 "field": "keyType",
21629 "field": "keyContent",
21636 "field": "idField",
21643 "field": "variableName",
21649 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21650 "version": "0.0.0",
21651 "filename": "server/api/intSalesforceField/index.js",
21652 "groupTitle": "Salesforce_Fields"
21656 "url": "/api/integrations/salesforce/fields/{id}",
21657 "title": "Deletes a Salesforce Field",
21660 "title": "Example usage:",
21661 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
21665 "name": "DeleteSalesforce_Fields",
21666 "group": "Salesforce_Fields",
21667 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21668 "version": "0.0.0",
21669 "filename": "server/api/intSalesforceField/index.js",
21670 "groupTitle": "Salesforce_Fields"
21674 "url": "/api/integrations/salesforce/fields",
21675 "title": "Gets a list of Salesforce Fields",
21678 "title": "Example usage:",
21679 "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
21683 "name": "GetSalesforce_Fields",
21684 "group": "Salesforce_Fields",
21685 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21686 "version": "0.0.0",
21687 "filename": "server/api/intSalesforceField/index.js",
21688 "groupTitle": "Salesforce_Fields"
21692 "url": "/api/integrations/salesforce/fields/{id}",
21693 "title": "Gets a single Salesforce Field",
21696 "title": "Example usage:",
21697 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
21701 "name": "ShowSalesforce_Fields",
21702 "group": "Salesforce_Fields",
21703 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21704 "version": "0.0.0",
21705 "filename": "server/api/intSalesforceField/index.js",
21706 "groupTitle": "Salesforce_Fields"
21710 "url": "/api/integrations/salesforce/fields/{id}",
21711 "title": "Update an existing Salesforce Field",
21714 "title": "Example usage:",
21715 "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",
21719 "name": "updateSalesforce_Fields",
21720 "group": "Salesforce_Fields",
21721 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21722 "version": "0.0.0",
21723 "filename": "server/api/intSalesforceField/index.js",
21724 "groupTitle": "Salesforce_Fields"
21728 "url": "/api/schedules",
21729 "title": "Creates a new Schedule",
21732 "title": "Example usage:",
21733 "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21737 "name": "CreateSchedules",
21738 "group": "Schedules",
21753 "field": "description",
21774 "field": "startAt",
21788 "field": "subtractNumber",
21804 "field": "subtractUnit",
21834 "field": "sendMail",
21862 "field": "sendIfEmpty",
21868 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21869 "version": "0.0.0",
21870 "filename": "server/api/schedule/index.js",
21871 "groupTitle": "Schedules"
21875 "url": "/api/schedules/{id}",
21876 "title": "Deletes a Schedule",
21879 "title": "Example usage:",
21880 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
21884 "name": "DeleteSchedules",
21885 "group": "Schedules",
21886 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21887 "version": "0.0.0",
21888 "filename": "server/api/schedule/index.js",
21889 "groupTitle": "Schedules"
21893 "url": "/api/schedules",
21894 "title": "Gets a list of Schedules",
21897 "title": "Example usage:",
21898 "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21902 "name": "GetSchedules",
21903 "group": "Schedules",
21904 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21905 "version": "0.0.0",
21906 "filename": "server/api/schedule/index.js",
21907 "groupTitle": "Schedules"
21911 "url": "/api/schedules/{id}",
21912 "title": "Gets a single Schedule",
21915 "title": "Example usage:",
21916 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21920 "name": "ShowSchedules",
21921 "group": "Schedules",
21922 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21923 "version": "0.0.0",
21924 "filename": "server/api/schedule/index.js",
21925 "groupTitle": "Schedules"
21929 "url": "/api/schedules/{id}/run",
21930 "title": "Run Scheduler",
21933 "title": "Example usage:",
21934 "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21939 "group": "Schedules",
21940 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21941 "version": "0.0.0",
21942 "filename": "server/api/schedule/index.js",
21943 "groupTitle": "Schedules"
21947 "url": "/api/schedules/{id}",
21948 "title": "Update an existing Schedule",
21951 "title": "Example usage:",
21952 "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21956 "name": "updateSchedules",
21957 "group": "Schedules",
21958 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21959 "version": "0.0.0",
21960 "filename": "server/api/schedule/index.js",
21961 "groupTitle": "Schedules"
21965 "url": "/api/screen/recordings",
21966 "title": "Creates a new Recording",
21969 "title": "Example usage:",
21970 "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21974 "name": "CreateRecordings",
21975 "group": "Screen_Recordings",
21990 "field": "interactionid",
21997 "field": "channel",
22018 "field": "duration",
22025 "field": "startedAt",
22032 "field": "closedAt",
22039 "field": "createdAt",
22046 "field": "updatedAt",
22052 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22053 "version": "0.0.0",
22054 "filename": "server/api/screenRecording/index.js",
22055 "groupTitle": "Screen_Recordings"
22059 "url": "/api/screen/recordings/describe",
22060 "title": "Gets table info about Recordings",
22063 "title": "Example usage:",
22064 "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
22068 "name": "DescribeRecordings",
22069 "group": "Screen_Recordings",
22070 "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>",
22071 "version": "0.0.0",
22072 "filename": "server/api/screenRecording/index.js",
22073 "groupTitle": "Screen_Recordings"
22077 "url": "/api/screen/recordings",
22078 "title": "Gets a list of Recordings",
22081 "title": "Example usage:",
22082 "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
22086 "name": "GetRecordings",
22087 "group": "Screen_Recordings",
22088 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22089 "version": "0.0.0",
22090 "filename": "server/api/screenRecording/index.js",
22091 "groupTitle": "Screen_Recordings"
22095 "url": "/api/screen/recordings/{id}",
22096 "title": "Gets a single Recording",
22099 "title": "Example usage:",
22100 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
22104 "name": "ShowRecordings",
22105 "group": "Screen_Recordings",
22106 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22107 "version": "0.0.0",
22108 "filename": "server/api/screenRecording/index.js",
22109 "groupTitle": "Screen_Recordings"
22113 "url": "/api/screen/recordings/{id}",
22114 "title": "Delete screen recording",
22117 "title": "Example usage:",
22118 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
22123 "group": "Screen_Recordings",
22124 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22125 "version": "0.0.0",
22126 "filename": "server/api/screenRecording/index.js",
22127 "groupTitle": "Screen_Recordings"
22131 "url": "/api/screen/recordings/{id}/download",
22132 "title": "Download Recording",
22135 "title": "Example usage:",
22136 "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
22140 "name": "download",
22141 "group": "Screen_Recordings",
22142 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22143 "version": "0.0.0",
22144 "filename": "server/api/screenRecording/index.js",
22145 "groupTitle": "Screen_Recordings"
22149 "url": "/api/screen/recordings/{id}",
22150 "title": "Update an existing Recording",
22153 "title": "Example usage:",
22154 "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",
22158 "name": "updateRecordings",
22159 "group": "Screen_Recordings",
22160 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22161 "version": "0.0.0",
22162 "filename": "server/api/screenRecording/index.js",
22163 "groupTitle": "Screen_Recordings"
22167 "url": "/api/integrations/servicenow/accounts",
22168 "title": "Creates a new Servicenow Account",
22171 "title": "Example usage:",
22172 "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",
22176 "name": "CreateServicenow_Accounts",
22177 "group": "Servicenow_Accounts",
22192 "field": "description",
22199 "field": "username",
22206 "field": "password",
22220 "field": "remoteUri",
22227 "field": "serverUrl",
22233 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22234 "version": "0.0.0",
22235 "filename": "server/api/intServicenowAccount/index.js",
22236 "groupTitle": "Servicenow_Accounts"
22240 "url": "/api/integrations/servicenow/accounts/{id}",
22241 "title": "Deletes a Servicenow Account",
22244 "title": "Example usage:",
22245 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
22249 "name": "DeleteServicenow_Accounts",
22250 "group": "Servicenow_Accounts",
22251 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22252 "version": "0.0.0",
22253 "filename": "server/api/intServicenowAccount/index.js",
22254 "groupTitle": "Servicenow_Accounts"
22258 "url": "/api/integrations/servicenow/accounts",
22259 "title": "Gets a list of Servicenow Accounts",
22262 "title": "Example usage:",
22263 "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
22267 "name": "GetServicenow_Accounts",
22268 "group": "Servicenow_Accounts",
22269 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22270 "version": "0.0.0",
22271 "filename": "server/api/intServicenowAccount/index.js",
22272 "groupTitle": "Servicenow_Accounts"
22276 "url": "/api/integrations/servicenow/accounts/{id}",
22277 "title": "Gets a single Servicenow Account",
22280 "title": "Example usage:",
22281 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
22285 "name": "ShowServicenow_Accounts",
22286 "group": "Servicenow_Accounts",
22287 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22288 "version": "0.0.0",
22289 "filename": "server/api/intServicenowAccount/index.js",
22290 "groupTitle": "Servicenow_Accounts"
22294 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
22295 "title": "Creates new configuration",
22298 "title": "Example usage:",
22299 "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",
22303 "name": "addConfiguration",
22304 "group": "Servicenow_Accounts",
22305 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22306 "version": "0.0.0",
22307 "filename": "server/api/intServicenowAccount/index.js",
22308 "groupTitle": "Servicenow_Accounts"
22312 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
22313 "title": "Gets account configurations",
22316 "title": "Example usage:",
22317 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
22321 "name": "getConfigurations",
22322 "group": "Servicenow_Accounts",
22323 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22324 "version": "0.0.0",
22325 "filename": "server/api/intServicenowAccount/index.js",
22326 "groupTitle": "Servicenow_Accounts"
22330 "url": "/api/integrations/servicenow/accounts/{id}/fields",
22331 "title": "Gets account fields",
22334 "title": "Example usage:",
22335 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
22339 "name": "getFields",
22340 "group": "Servicenow_Accounts",
22341 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22342 "version": "0.0.0",
22343 "filename": "server/api/intServicenowAccount/index.js",
22344 "groupTitle": "Servicenow_Accounts"
22348 "url": "/api/integrations/servicenow/accounts/{id}",
22349 "title": "Update an existing Servicenow Account",
22352 "title": "Example usage:",
22353 "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",
22357 "name": "updateServicenow_Accounts",
22358 "group": "Servicenow_Accounts",
22359 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22360 "version": "0.0.0",
22361 "filename": "server/api/intServicenowAccount/index.js",
22362 "groupTitle": "Servicenow_Accounts"
22366 "url": "/api/integrations/servicenow/configurations",
22367 "title": "Creates a new Servicenow Configuration",
22370 "title": "Example usage:",
22371 "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",
22375 "name": "CreateServicenow_Configurations",
22376 "group": "Servicenow_Configurations",
22391 "field": "description",
22397 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22398 "version": "0.0.0",
22399 "filename": "server/api/intServicenowConfiguration/index.js",
22400 "groupTitle": "Servicenow_Configurations"
22404 "url": "/api/integrations/servicenow/configurations/{id}",
22405 "title": "Deletes a Servicenow Configuration",
22408 "title": "Example usage:",
22409 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
22413 "name": "DeleteServicenow_Configurations",
22414 "group": "Servicenow_Configurations",
22415 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22416 "version": "0.0.0",
22417 "filename": "server/api/intServicenowConfiguration/index.js",
22418 "groupTitle": "Servicenow_Configurations"
22422 "url": "/api/integrations/servicenow/configurations",
22423 "title": "Gets a list of Servicenow Configurations",
22426 "title": "Example usage:",
22427 "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
22431 "name": "GetServicenow_Configurations",
22432 "group": "Servicenow_Configurations",
22433 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22434 "version": "0.0.0",
22435 "filename": "server/api/intServicenowConfiguration/index.js",
22436 "groupTitle": "Servicenow_Configurations"
22440 "url": "/api/integrations/servicenow/configurations/{id}",
22441 "title": "Gets a single Servicenow Configuration",
22444 "title": "Example usage:",
22445 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
22449 "name": "ShowServicenow_Configurations",
22450 "group": "Servicenow_Configurations",
22451 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22452 "version": "0.0.0",
22453 "filename": "server/api/intServicenowConfiguration/index.js",
22454 "groupTitle": "Servicenow_Configurations"
22458 "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
22459 "title": "Gets configurations descriptions",
22462 "title": "Example usage:",
22463 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
22467 "name": "getDescriptions",
22468 "group": "Servicenow_Configurations",
22469 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22470 "version": "0.0.0",
22471 "filename": "server/api/intServicenowConfiguration/index.js",
22472 "groupTitle": "Servicenow_Configurations"
22476 "url": "/api/integrations/servicenow/configurations/{id}/fields",
22477 "title": "Gets configurations fields",
22480 "title": "Example usage:",
22481 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
22485 "name": "getFields",
22486 "group": "Servicenow_Configurations",
22487 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22488 "version": "0.0.0",
22489 "filename": "server/api/intServicenowConfiguration/index.js",
22490 "groupTitle": "Servicenow_Configurations"
22494 "url": "/api/integrations/servicenow/configurations/{id}/subjects",
22495 "title": "Gets configurations subjects",
22498 "title": "Example usage:",
22499 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
22503 "name": "getSubjects",
22504 "group": "Servicenow_Configurations",
22505 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22506 "version": "0.0.0",
22507 "filename": "server/api/intServicenowConfiguration/index.js",
22508 "groupTitle": "Servicenow_Configurations"
22512 "url": "/api/integrations/servicenow/configurations/{id}",
22513 "title": "Update an existing Servicenow Configuration",
22516 "title": "Example usage:",
22517 "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",
22521 "name": "updateServicenow_Configurations",
22522 "group": "Servicenow_Configurations",
22523 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22524 "version": "0.0.0",
22525 "filename": "server/api/intServicenowConfiguration/index.js",
22526 "groupTitle": "Servicenow_Configurations"
22530 "url": "/api/integrations/servicenow/fields",
22531 "title": "Creates a new Servicenow Field",
22534 "title": "Example usage:",
22535 "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",
22539 "name": "CreateServicenow_Fields",
22540 "group": "Servicenow_Fields",
22550 "\"customVariable\"",
22562 "field": "content",
22578 "\"customVariable\""
22581 "field": "keyType",
22588 "field": "keyContent",
22595 "field": "idField",
22602 "field": "nameField",
22609 "field": "customField",
22616 "field": "variableName",
22622 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22623 "version": "0.0.0",
22624 "filename": "server/api/intServicenowField/index.js",
22625 "groupTitle": "Servicenow_Fields"
22629 "url": "/api/integrations/servicenow/fields/{id}",
22630 "title": "Deletes a Servicenow Field",
22633 "title": "Example usage:",
22634 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
22638 "name": "DeleteServicenow_Fields",
22639 "group": "Servicenow_Fields",
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/intServicenowField/index.js",
22643 "groupTitle": "Servicenow_Fields"
22647 "url": "/api/integrations/servicenow/fields",
22648 "title": "Gets a list of Servicenow Fields",
22651 "title": "Example usage:",
22652 "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
22656 "name": "GetServicenow_Fields",
22657 "group": "Servicenow_Fields",
22658 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22659 "version": "0.0.0",
22660 "filename": "server/api/intServicenowField/index.js",
22661 "groupTitle": "Servicenow_Fields"
22665 "url": "/api/integrations/servicenow/fields/{id}",
22666 "title": "Gets a single Servicenow Field",
22669 "title": "Example usage:",
22670 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
22674 "name": "ShowServicenow_Fields",
22675 "group": "Servicenow_Fields",
22676 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/intServicenowField/index.js",
22679 "groupTitle": "Servicenow_Fields"
22683 "url": "/api/integrations/servicenow/fields/{id}",
22684 "title": "Update an existing Servicenow Field",
22687 "title": "Example usage:",
22688 "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",
22692 "name": "updateServicenow_Fields",
22693 "group": "Servicenow_Fields",
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/intServicenowField/index.js",
22697 "groupTitle": "Servicenow_Fields"
22701 "url": "/api/settings",
22702 "title": "Gets a list of Settings",
22705 "title": "Example usage:",
22706 "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
22710 "name": "GetSettings",
22711 "group": "Settings",
22712 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22713 "version": "0.0.0",
22714 "filename": "server/api/setting/index.js",
22715 "groupTitle": "Settings"
22719 "url": "/api/settings/{id}",
22720 "title": "Gets a single Setting",
22723 "title": "Example usage:",
22724 "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
22728 "name": "ShowSettings",
22729 "group": "Settings",
22730 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22731 "version": "0.0.0",
22732 "filename": "server/api/setting/index.js",
22733 "groupTitle": "Settings"
22737 "url": "/api/settings/{id}/favicon",
22738 "title": "Add Favicon",
22741 "title": "Example usage:",
22742 "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22746 "name": "addFavicon",
22747 "group": "Settings",
22748 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22749 "version": "0.0.0",
22750 "filename": "server/api/setting/index.js",
22751 "groupTitle": "Settings"
22755 "url": "/api/settings/{id}/logo",
22756 "title": "Add logo",
22759 "title": "Example usage:",
22760 "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22765 "group": "Settings",
22766 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22767 "version": "0.0.0",
22768 "filename": "server/api/setting/index.js",
22769 "groupTitle": "Settings"
22773 "url": "/api/settings/{id}/logo_login",
22774 "title": "Add logo login",
22777 "title": "Example usage:",
22778 "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22782 "name": "addLogoLogin",
22783 "group": "Settings",
22784 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22785 "version": "0.0.0",
22786 "filename": "server/api/setting/index.js",
22787 "groupTitle": "Settings"
22791 "url": "/api/settings/{id}/preferred",
22792 "title": "Add Preferred",
22795 "title": "Example usage:",
22796 "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22800 "name": "addPreferred",
22801 "group": "Settings",
22802 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22803 "version": "0.0.0",
22804 "filename": "server/api/setting/index.js",
22805 "groupTitle": "Settings"
22809 "url": "/api/settings/now",
22810 "title": "Get Server Current Date",
22813 "title": "Example usage:",
22814 "content": "curl https://{domain}/api/settings/now -v -X GET",
22819 "group": "Settings",
22820 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22821 "version": "0.0.0",
22822 "filename": "server/api/setting/index.js",
22823 "groupTitle": "Settings"
22827 "url": "/api/settings/{id}/favicon",
22828 "title": "Get Favicon",
22831 "title": "Example usage:",
22832 "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
22836 "name": "getFavicon",
22837 "group": "Settings",
22838 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22839 "version": "0.0.0",
22840 "filename": "server/api/setting/index.js",
22841 "groupTitle": "Settings"
22845 "url": "/api/settings/{id}/gdpr",
22846 "title": "Get gdpr settings",
22849 "title": "Example usage:",
22850 "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
22855 "group": "Settings",
22856 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22857 "version": "0.0.0",
22858 "filename": "server/api/setting/index.js",
22859 "groupTitle": "Settings"
22863 "url": "/api/settings/{id}/logo",
22864 "title": "Get logo",
22867 "title": "Example usage:",
22868 "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
22873 "group": "Settings",
22874 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22875 "version": "0.0.0",
22876 "filename": "server/api/setting/index.js",
22877 "groupTitle": "Settings"
22881 "url": "/api/settings/{id}/logo_login",
22882 "title": "Get logo login",
22885 "title": "Example usage:",
22886 "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
22890 "name": "getLogoLogin",
22891 "group": "Settings",
22892 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22893 "version": "0.0.0",
22894 "filename": "server/api/setting/index.js",
22895 "groupTitle": "Settings"
22899 "url": "/api/settings/{id}/preferred",
22900 "title": "Get Preferred",
22903 "title": "Example usage:",
22904 "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22908 "name": "getPreferred",
22909 "group": "Settings",
22910 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22911 "version": "0.0.0",
22912 "filename": "server/api/setting/index.js",
22913 "groupTitle": "Settings"
22917 "url": "/api/settings/{id}",
22918 "title": "Update an existing Setting",
22921 "title": "Example usage:",
22922 "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22926 "name": "updateSettings",
22927 "group": "Settings",
22928 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22929 "version": "0.0.0",
22930 "filename": "server/api/setting/index.js",
22931 "groupTitle": "Settings"
22935 "url": "/api/sms/accounts/{id}/users",
22936 "title": "Add agents to a sms account",
22939 "title": "Example usage:",
22940 "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",
22944 "name": "AddAgents",
22945 "group": "Sms_Accounts",
22946 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22947 "version": "0.0.0",
22948 "filename": "server/api/smsAccount/index.js",
22949 "groupTitle": "Sms_Accounts"
22953 "url": "/api/sms/accounts",
22954 "title": "Creates a new Account",
22957 "title": "Example usage:",
22958 "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22962 "name": "CreateAccounts",
22963 "group": "Sms_Accounts",
23025 "field": "accountSid",
23039 "field": "authToken",
23051 "field": "smsMethod",
23058 "field": "username",
23065 "field": "password",
23079 "field": "applicationId",
23086 "field": "accountId",
23093 "field": "senderString",
23100 "field": "deliveryReport",
23107 "field": "description",
23114 "field": "notificationTemplate",
23121 "field": "notificationSound",
23128 "field": "notificationShake",
23135 "field": "waitForTheAssignedAgent",
23142 "field": "waitForTheAssignedQueue",
23149 "field": "queueTransfer",
23156 "field": "queueTransferTimeout",
23163 "field": "agentTransfer",
23170 "field": "agentTransferTimeout",
23177 "field": "baseUrl",
23184 "field": "mandatoryDispositionPauseId",
23185 "description": "<p>Status to put when mandatory disposition is enabled</p>"
23191 "field": "mandatoryDisposition",
23192 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
23197 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23198 "version": "0.0.0",
23199 "filename": "server/api/smsAccount/index.js",
23200 "groupTitle": "Sms_Accounts"
23204 "url": "/api/sms/accounts/{id}",
23205 "title": "Deletes a Account",
23208 "title": "Example usage:",
23209 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
23213 "name": "DeleteAccounts",
23214 "group": "Sms_Accounts",
23215 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23216 "version": "0.0.0",
23217 "filename": "server/api/smsAccount/index.js",
23218 "groupTitle": "Sms_Accounts"
23222 "url": "/api/sms/accounts/describe",
23223 "title": "Gets table info about Accounts",
23226 "title": "Example usage:",
23227 "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
23231 "name": "DescribeAccounts",
23232 "group": "Sms_Accounts",
23233 "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>",
23234 "version": "0.0.0",
23235 "filename": "server/api/smsAccount/index.js",
23236 "groupTitle": "Sms_Accounts"
23240 "url": "/api/sms/accounts",
23241 "title": "Gets a list of Accounts",
23244 "title": "Example usage:",
23245 "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
23249 "name": "GetAccounts",
23250 "group": "Sms_Accounts",
23251 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23252 "version": "0.0.0",
23253 "filename": "server/api/smsAccount/index.js",
23254 "groupTitle": "Sms_Accounts"
23258 "url": "/api/sms/accounts/{id}/users",
23259 "title": "Gets agents from sms account",
23262 "title": "Example usage:",
23263 "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
23267 "name": "GetAgents",
23268 "group": "Sms_Accounts",
23269 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23270 "version": "0.0.0",
23271 "filename": "server/api/smsAccount/index.js",
23272 "groupTitle": "Sms_Accounts"
23276 "url": "/api/sms/accounts/{id}/users",
23277 "title": "Removes agents from a sms account",
23280 "title": "Example usage:",
23281 "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23285 "name": "RemoveAgents",
23286 "group": "Sms_Accounts",
23287 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23288 "version": "0.0.0",
23289 "filename": "server/api/smsAccount/index.js",
23290 "groupTitle": "Sms_Accounts"
23294 "url": "/api/sms/accounts/{id}/canned_answers",
23295 "title": "Removes canned answers from account",
23298 "title": "Example usage:",
23299 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23303 "name": "RemoveAnswers",
23304 "group": "Sms_Accounts",
23305 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23306 "version": "0.0.0",
23307 "filename": "server/api/smsAccount/index.js",
23308 "groupTitle": "Sms_Accounts"
23312 "url": "/api/sms/accounts/{id}/dispositions",
23313 "title": "Removes dispositions from account",
23316 "title": "Example usage:",
23317 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23321 "name": "RemoveDispositions",
23322 "group": "Sms_Accounts",
23323 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23324 "version": "0.0.0",
23325 "filename": "server/api/smsAccount/index.js",
23326 "groupTitle": "Sms_Accounts"
23330 "url": "/api/sms/accounts/{id}",
23331 "title": "Gets a single Account",
23334 "title": "Example usage:",
23335 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
23339 "name": "ShowAccounts",
23340 "group": "Sms_Accounts",
23341 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23342 "version": "0.0.0",
23343 "filename": "server/api/smsAccount/index.js",
23344 "groupTitle": "Sms_Accounts"
23348 "url": "/api/sms/messages/{id}/accept",
23349 "title": "Accepts message",
23352 "title": "Example usage:",
23353 "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
23357 "name": "acceptMessage",
23358 "group": "Sms_Accounts",
23359 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23360 "version": "0.0.0",
23361 "filename": "server/api/smsMessage/index.js",
23362 "groupTitle": "Sms_Accounts"
23366 "url": "/api/sms/accounts/{id}/canned_answers",
23367 "title": "Creates new canned answer",
23370 "title": "Example usage:",
23371 "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",
23375 "name": "addAnswer",
23376 "group": "Sms_Accounts",
23398 "field": "description",
23411 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23412 "version": "0.0.0",
23413 "filename": "server/api/smsAccount/index.js",
23414 "groupTitle": "Sms_Accounts"
23418 "url": "/api/sms/accounts/{id}/applications",
23419 "title": "Creates new applications",
23422 "title": "Example usage:",
23423 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23427 "name": "addApplications",
23428 "group": "Sms_Accounts",
23436 "field": "priority",
23450 "field": "appdata",
23457 "field": "description",
23464 "field": "interval",
23470 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23471 "version": "0.0.0",
23472 "filename": "server/api/smsAccount/index.js",
23473 "groupTitle": "Sms_Accounts"
23477 "url": "/api/sms/accounts/{id}/dispositions",
23478 "title": "Creates new disposition",
23481 "title": "Example usage:",
23482 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23486 "name": "addDisposition",
23487 "group": "Sms_Accounts",
23514 "field": "description",
23520 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23521 "version": "0.0.0",
23522 "filename": "server/api/smsAccount/index.js",
23523 "groupTitle": "Sms_Accounts"
23527 "url": "/api/sms/accounts/{id}/canned_answers",
23528 "title": "Gets account canned answers",
23531 "title": "Example usage:",
23532 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
23536 "name": "getAnswers",
23537 "group": "Sms_Accounts",
23538 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23539 "version": "0.0.0",
23540 "filename": "server/api/smsAccount/index.js",
23541 "groupTitle": "Sms_Accounts"
23545 "url": "/api/sms/accounts/{id}/applications",
23546 "title": "Gets account applications",
23549 "title": "Example usage:",
23550 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
23554 "name": "getApplications",
23555 "group": "Sms_Accounts",
23556 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23557 "version": "0.0.0",
23558 "filename": "server/api/smsAccount/index.js",
23559 "groupTitle": "Sms_Accounts"
23563 "url": "/api/sms/accounts/{id}/dispositions",
23564 "title": "Gets account dispositions",
23567 "title": "Example usage:",
23568 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
23572 "name": "getDispositions",
23573 "group": "Sms_Accounts",
23574 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23575 "version": "0.0.0",
23576 "filename": "server/api/smsAccount/index.js",
23577 "groupTitle": "Sms_Accounts"
23581 "url": "/api/sms/accounts/{id}/interactions",
23582 "title": "Gets Sms Account interactions",
23585 "title": "Example usage:",
23586 "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
23590 "name": "getInteractions",
23591 "group": "Sms_Accounts",
23592 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23593 "version": "0.0.0",
23594 "filename": "server/api/smsAccount/index.js",
23595 "groupTitle": "Sms_Accounts"
23599 "url": "/api/sms/accounts/{id}/notify",
23600 "title": "Notify new message",
23603 "title": "Example usage:",
23604 "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",
23609 "group": "Sms_Accounts",
23610 "description": "<p>Motion 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>",
23611 "version": "0.0.0",
23612 "filename": "server/api/smsAccount/index.js",
23613 "groupTitle": "Sms_Accounts"
23617 "url": "/api/sms/messages/{id}/reject",
23618 "title": "Rejects message",
23621 "title": "Example usage:",
23622 "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
23626 "name": "rejectMessage",
23627 "group": "Sms_Accounts",
23628 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23629 "version": "0.0.0",
23630 "filename": "server/api/smsMessage/index.js",
23631 "groupTitle": "Sms_Accounts"
23635 "url": "/api/sms/accounts/{id}/send",
23636 "title": "Send new sms message",
23639 "title": "Example usage:",
23640 "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",
23645 "group": "Sms_Accounts",
23646 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23647 "version": "0.0.0",
23648 "filename": "server/api/smsAccount/index.js",
23649 "groupTitle": "Sms_Accounts"
23653 "url": "/api/sms/accounts/{id}/status",
23654 "title": "Receive message status as get request",
23657 "title": "Example usage:",
23658 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
23662 "name": "statusMessage",
23663 "group": "Sms_Accounts",
23664 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23665 "version": "0.0.0",
23666 "filename": "server/api/smsAccount/index.js",
23667 "groupTitle": "Sms_Accounts"
23671 "url": "/api/sms/accounts/{id}/status",
23672 "title": "Receive message status",
23675 "title": "Example usage:",
23676 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
23680 "name": "statusMessage",
23681 "group": "Sms_Accounts",
23682 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23683 "version": "0.0.0",
23684 "filename": "server/api/smsAccount/index.js",
23685 "groupTitle": "Sms_Accounts"
23689 "url": "/api/sms/messages/{id}/status",
23690 "title": "Receive message status",
23693 "title": "Example usage:",
23694 "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
23698 "name": "statusMessage",
23699 "group": "Sms_Accounts",
23700 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23701 "version": "0.0.0",
23702 "filename": "server/api/smsMessage/index.js",
23703 "groupTitle": "Sms_Accounts"
23707 "url": "/api/sms/accounts/{id}",
23708 "title": "Update an existing Account",
23711 "title": "Example usage:",
23712 "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",
23716 "name": "updateAccounts",
23717 "group": "Sms_Accounts",
23718 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23719 "version": "0.0.0",
23720 "filename": "server/api/smsAccount/index.js",
23721 "groupTitle": "Sms_Accounts"
23725 "url": "/api/sms/applications",
23726 "title": "Creates a new Application",
23729 "title": "Example usage:",
23730 "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23734 "name": "CreateApplications",
23735 "group": "Sms_Applications",
23743 "field": "priority",
23757 "field": "appdata",
23764 "field": "description",
23771 "field": "interval",
23777 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23778 "version": "0.0.0",
23779 "filename": "server/api/smsApplication/index.js",
23780 "groupTitle": "Sms_Applications"
23784 "url": "/api/sms/applications/{id}",
23785 "title": "Deletes a Application",
23788 "title": "Example usage:",
23789 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
23793 "name": "DeleteApplications",
23794 "group": "Sms_Applications",
23795 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23796 "version": "0.0.0",
23797 "filename": "server/api/smsApplication/index.js",
23798 "groupTitle": "Sms_Applications"
23802 "url": "/api/sms/applications",
23803 "title": "Gets a list of Applications",
23806 "title": "Example usage:",
23807 "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
23811 "name": "GetApplications",
23812 "group": "Sms_Applications",
23813 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23814 "version": "0.0.0",
23815 "filename": "server/api/smsApplication/index.js",
23816 "groupTitle": "Sms_Applications"
23820 "url": "/api/sms/applications/{id}",
23821 "title": "Gets a single Application",
23824 "title": "Example usage:",
23825 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
23829 "name": "ShowApplications",
23830 "group": "Sms_Applications",
23831 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23832 "version": "0.0.0",
23833 "filename": "server/api/smsApplication/index.js",
23834 "groupTitle": "Sms_Applications"
23838 "url": "/api/sms/applications/{id}",
23839 "title": "Update an existing Application",
23842 "title": "Example usage:",
23843 "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",
23847 "name": "updateApplications",
23848 "group": "Sms_Applications",
23849 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23850 "version": "0.0.0",
23851 "filename": "server/api/smsApplication/index.js",
23852 "groupTitle": "Sms_Applications"
23856 "url": "/api/sms/interactions/{id}/tags",
23857 "title": "Add tags to the interaction",
23860 "title": "Example usage:",
23861 "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",
23866 "group": "Sms_Interactions",
23867 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23868 "version": "0.0.0",
23869 "filename": "server/api/smsInteraction/index.js",
23870 "groupTitle": "Sms_Interactions"
23874 "url": "/api/sms/interactions",
23875 "title": "Creates a new Interaction",
23878 "title": "Example usage:",
23879 "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23883 "name": "CreateInteractions",
23884 "group": "Sms_Interactions",
23899 "field": "closedAt",
23906 "field": "disposition",
23913 "field": "secondDisposition",
23920 "field": "thirdDisposition",
23941 "field": "read1stAt",
23952 "field": "firstMsgDirection",
23959 "field": "lastMsgAt",
23970 "field": "lastMsgDirection",
23977 "field": "autoreplyExecuted",
23983 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23984 "version": "0.0.0",
23985 "filename": "server/api/smsInteraction/index.js",
23986 "groupTitle": "Sms_Interactions"
23990 "url": "/api/sms/interactions/{id}",
23991 "title": "Deletes a Interaction",
23994 "title": "Example usage:",
23995 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23999 "name": "DeleteInteractions",
24000 "group": "Sms_Interactions",
24001 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24002 "version": "0.0.0",
24003 "filename": "server/api/smsInteraction/index.js",
24004 "groupTitle": "Sms_Interactions"
24008 "url": "/api/sms/interactions/describe",
24009 "title": "Gets table info about Interactions",
24012 "title": "Example usage:",
24013 "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
24017 "name": "DescribeInteractions",
24018 "group": "Sms_Interactions",
24019 "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>",
24020 "version": "0.0.0",
24021 "filename": "server/api/smsInteraction/index.js",
24022 "groupTitle": "Sms_Interactions"
24026 "url": "/api/sms/interactions",
24027 "title": "Gets a list of Interactions",
24030 "title": "Example usage:",
24031 "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
24035 "name": "GetInteractions",
24036 "group": "Sms_Interactions",
24037 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24038 "version": "0.0.0",
24039 "filename": "server/api/smsInteraction/index.js",
24040 "groupTitle": "Sms_Interactions"
24044 "url": "/api/sms/interactions/{id}/tags",
24045 "title": "Removes tags from interaction",
24048 "title": "Example usage:",
24049 "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24053 "name": "RemoveTags",
24054 "group": "Sms_Interactions",
24055 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24056 "version": "0.0.0",
24057 "filename": "server/api/smsInteraction/index.js",
24058 "groupTitle": "Sms_Interactions"
24062 "url": "/api/sms/interactions/{id}",
24063 "title": "Gets a single Interaction",
24066 "title": "Example usage:",
24067 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
24071 "name": "ShowInteractions",
24072 "group": "Sms_Interactions",
24073 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24074 "version": "0.0.0",
24075 "filename": "server/api/smsInteraction/index.js",
24076 "groupTitle": "Sms_Interactions"
24080 "url": "/api/sms/interactions/{id}/messages",
24081 "title": "Creates new messages",
24084 "title": "Example usage:",
24085 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
24089 "name": "addMessage",
24090 "group": "Sms_Interactions",
24116 "field": "direction",
24123 "field": "messageId",
24151 "field": "providerName",
24158 "field": "providerResponse",
24164 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24165 "version": "0.0.0",
24166 "filename": "server/api/smsInteraction/index.js",
24167 "groupTitle": "Sms_Interactions"
24171 "url": "/api/sms/interactions/{id}/download",
24172 "title": "Gets interaction",
24175 "title": "Example usage:",
24176 "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
24180 "name": "download",
24181 "group": "Sms_Interactions",
24182 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24183 "version": "0.0.0",
24184 "filename": "server/api/smsInteraction/index.js",
24185 "groupTitle": "Sms_Interactions"
24189 "url": "/api/sms/interactions/{id}/messages",
24190 "title": "Gets interaction messages",
24193 "title": "Example usage:",
24194 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
24198 "name": "getMessages",
24199 "group": "Sms_Interactions",
24200 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24201 "version": "0.0.0",
24202 "filename": "server/api/smsInteraction/index.js",
24203 "groupTitle": "Sms_Interactions"
24207 "url": "/api/sms/interactions/{id}",
24208 "title": "Update an existing Interaction",
24211 "title": "Example usage:",
24212 "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",
24216 "name": "updateInteractions",
24217 "group": "Sms_Interactions",
24218 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24219 "version": "0.0.0",
24220 "filename": "server/api/smsInteraction/index.js",
24221 "groupTitle": "Sms_Interactions"
24225 "url": "/api/sms/messages",
24226 "title": "Creates a new Message",
24229 "title": "Example usage:",
24230 "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24234 "name": "CreateMessages",
24235 "group": "Sms_Messages",
24261 "field": "direction",
24268 "field": "messageId",
24296 "field": "providerName",
24303 "field": "providerResponse",
24309 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24310 "version": "0.0.0",
24311 "filename": "server/api/smsMessage/index.js",
24312 "groupTitle": "Sms_Messages"
24316 "url": "/api/sms/messages/{id}",
24317 "title": "Deletes a Message",
24320 "title": "Example usage:",
24321 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
24325 "name": "DeleteMessages",
24326 "group": "Sms_Messages",
24327 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24328 "version": "0.0.0",
24329 "filename": "server/api/smsMessage/index.js",
24330 "groupTitle": "Sms_Messages"
24334 "url": "/api/sms/messages/describe",
24335 "title": "Gets table info about Messages",
24338 "title": "Example usage:",
24339 "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
24343 "name": "DescribeMessages",
24344 "group": "Sms_Messages",
24345 "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>",
24346 "version": "0.0.0",
24347 "filename": "server/api/smsMessage/index.js",
24348 "groupTitle": "Sms_Messages"
24352 "url": "/api/sms/messages",
24353 "title": "Gets a list of Messages",
24356 "title": "Example usage:",
24357 "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
24361 "name": "GetMessages",
24362 "group": "Sms_Messages",
24363 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24364 "version": "0.0.0",
24365 "filename": "server/api/smsMessage/index.js",
24366 "groupTitle": "Sms_Messages"
24370 "url": "/api/sms/messages/{id}",
24371 "title": "Gets a single Message",
24374 "title": "Example usage:",
24375 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
24379 "name": "ShowMessages",
24380 "group": "Sms_Messages",
24381 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24382 "version": "0.0.0",
24383 "filename": "server/api/smsMessage/index.js",
24384 "groupTitle": "Sms_Messages"
24388 "url": "/api/sms/messages/{id}",
24389 "title": "Update an existing Message",
24392 "title": "Example usage:",
24393 "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",
24397 "name": "updateMessages",
24398 "group": "Sms_Messages",
24399 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24400 "version": "0.0.0",
24401 "filename": "server/api/smsMessage/index.js",
24402 "groupTitle": "Sms_Messages"
24406 "url": "/api/sms/reports/queue",
24407 "title": "Creates a new Sms Queue Report",
24410 "title": "Example usage:",
24411 "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",
24415 "name": "CreateSms_Queue_Reports",
24416 "group": "Sms_Queue_Reports",
24424 "field": "uniqueid",
24445 "field": "leaveAt",
24452 "field": "acceptAt",
24472 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24473 "version": "0.0.0",
24474 "filename": "server/api/smsQueueReport/index.js",
24475 "groupTitle": "Sms_Queue_Reports"
24479 "url": "/api/sms/reports/queue/{id}",
24480 "title": "Deletes a Sms Queue Report",
24483 "title": "Example usage:",
24484 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
24488 "name": "DeleteSms_Queue_Reports",
24489 "group": "Sms_Queue_Reports",
24490 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24491 "version": "0.0.0",
24492 "filename": "server/api/smsQueueReport/index.js",
24493 "groupTitle": "Sms_Queue_Reports"
24497 "url": "/api/sms/reports/queue/describe",
24498 "title": "Gets table info about Sms Queue Reports",
24501 "title": "Example usage:",
24502 "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
24506 "name": "DescribeSms_Queue_Reports",
24507 "group": "Sms_Queue_Reports",
24508 "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>",
24509 "version": "0.0.0",
24510 "filename": "server/api/smsQueueReport/index.js",
24511 "groupTitle": "Sms_Queue_Reports"
24515 "url": "/api/sms/reports/queue",
24516 "title": "Gets a list of Sms Queue Reports",
24519 "title": "Example usage:",
24520 "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
24524 "name": "GetSms_Queue_Reports",
24525 "group": "Sms_Queue_Reports",
24526 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24527 "version": "0.0.0",
24528 "filename": "server/api/smsQueueReport/index.js",
24529 "groupTitle": "Sms_Queue_Reports"
24533 "url": "/api/sms/reports/queue/{id}",
24534 "title": "Gets a single Sms Queue Report",
24537 "title": "Example usage:",
24538 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
24542 "name": "ShowSms_Queue_Reports",
24543 "group": "Sms_Queue_Reports",
24544 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24545 "version": "0.0.0",
24546 "filename": "server/api/smsQueueReport/index.js",
24547 "groupTitle": "Sms_Queue_Reports"
24551 "url": "/api/sms/reports/queue/{id}",
24552 "title": "Update an existing Sms Queue Report",
24555 "title": "Example usage:",
24556 "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",
24560 "name": "updateSms_Queue_Reports",
24561 "group": "Sms_Queue_Reports",
24562 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24563 "version": "0.0.0",
24564 "filename": "server/api/smsQueueReport/index.js",
24565 "groupTitle": "Sms_Queue_Reports"
24569 "url": "/api/sms/queues/{id}/users",
24570 "title": "Add agents to a queue",
24573 "title": "Example usage:",
24574 "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",
24578 "name": "AddAgents",
24579 "group": "Sms_Queues",
24580 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24581 "version": "0.0.0",
24582 "filename": "server/api/smsQueue/index.js",
24583 "groupTitle": "Sms_Queues"
24587 "url": "/api/sms/queues/{id}/teams",
24588 "title": "Add teams to a queue",
24591 "title": "Example usage:",
24592 "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",
24596 "name": "AddTeams",
24597 "group": "Sms_Queues",
24598 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24599 "version": "0.0.0",
24600 "filename": "server/api/smsQueue/index.js",
24601 "groupTitle": "Sms_Queues"
24605 "url": "/api/sms/queues",
24606 "title": "Creates a new Queue",
24609 "title": "Example usage:",
24610 "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24614 "name": "CreateQueues",
24615 "group": "Sms_Queues",
24630 "field": "description",
24637 "field": "timeout",
24649 "field": "strategy",
24655 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24656 "version": "0.0.0",
24657 "filename": "server/api/smsQueue/index.js",
24658 "groupTitle": "Sms_Queues"
24662 "url": "/api/sms/queues/{id}",
24663 "title": "Deletes a Queue",
24666 "title": "Example usage:",
24667 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
24671 "name": "DeleteQueues",
24672 "group": "Sms_Queues",
24673 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24674 "version": "0.0.0",
24675 "filename": "server/api/smsQueue/index.js",
24676 "groupTitle": "Sms_Queues"
24680 "url": "/api/sms/queues/describe",
24681 "title": "Gets table info about Queues",
24684 "title": "Example usage:",
24685 "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
24689 "name": "DescribeQueues",
24690 "group": "Sms_Queues",
24691 "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>",
24692 "version": "0.0.0",
24693 "filename": "server/api/smsQueue/index.js",
24694 "groupTitle": "Sms_Queues"
24698 "url": "/api/sms/queues/{id}/users",
24699 "title": "Gets queue agents",
24702 "title": "Example usage:",
24703 "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
24707 "name": "GetAgents",
24708 "group": "Sms_Queues",
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/smsQueue/index.js",
24712 "groupTitle": "Sms_Queues"
24716 "url": "/api/sms/queues/{id}/members",
24717 "title": "GetMembers",
24720 "title": "Example usage:",
24721 "content": "curl https://{domain}/api/sms/queues/{id}/members -v -u {name}:{password}",
24725 "name": "GetMembers",
24726 "group": "Sms_Queues",
24727 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24728 "version": "0.0.0",
24729 "filename": "server/api/smsQueue/index.js",
24730 "groupTitle": "Sms_Queues"
24734 "url": "/api/sms/queues",
24735 "title": "Gets a list of Queues",
24738 "title": "Example usage:",
24739 "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
24743 "name": "GetQueues",
24744 "group": "Sms_Queues",
24745 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24746 "version": "0.0.0",
24747 "filename": "server/api/smsQueue/index.js",
24748 "groupTitle": "Sms_Queues"
24752 "url": "/api/sms/queues/{id}/teams",
24753 "title": "Gets queues list",
24756 "title": "Example usage:",
24757 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
24761 "name": "GetTeams",
24762 "group": "Sms_Queues",
24763 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24764 "version": "0.0.0",
24765 "filename": "server/api/smsQueue/index.js",
24766 "groupTitle": "Sms_Queues"
24770 "url": "/api/sms/queues/{id}/users",
24771 "title": "Removes agents from a queue",
24774 "title": "Example usage:",
24775 "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24779 "name": "RemoveAgents",
24780 "group": "Sms_Queues",
24781 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24782 "version": "0.0.0",
24783 "filename": "server/api/smsQueue/index.js",
24784 "groupTitle": "Sms_Queues"
24788 "url": "/api/sms/queues/{id}",
24789 "title": "Gets a single Queue",
24792 "title": "Example usage:",
24793 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
24797 "name": "ShowQueues",
24798 "group": "Sms_Queues",
24799 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24800 "version": "0.0.0",
24801 "filename": "server/api/smsQueue/index.js",
24802 "groupTitle": "Sms_Queues"
24806 "url": "/api/sms/queues/{id}",
24807 "title": "Update an existing Queue",
24810 "title": "Example usage:",
24811 "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",
24815 "name": "updateQueues",
24816 "group": "Sms_Queues",
24817 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24818 "version": "0.0.0",
24819 "filename": "server/api/smsQueue/index.js",
24820 "groupTitle": "Sms_Queues"
24824 "url": "/api/sms/reports/transfer",
24825 "title": "Creates a new Sms Transfer Report",
24828 "title": "Example usage:",
24829 "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",
24833 "name": "CreateSms_Transfer_Reports",
24834 "group": "Sms_Transfer_Reports",
24842 "field": "uniqueid",
24861 "field": "transferredAt",
24867 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24868 "version": "0.0.0",
24869 "filename": "server/api/smsTransferReport/index.js",
24870 "groupTitle": "Sms_Transfer_Reports"
24874 "url": "/api/sms/reports/transfer/{id}",
24875 "title": "Deletes a Sms Transfer Report",
24878 "title": "Example usage:",
24879 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
24883 "name": "DeleteSms_Transfer_Reports",
24884 "group": "Sms_Transfer_Reports",
24885 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24886 "version": "0.0.0",
24887 "filename": "server/api/smsTransferReport/index.js",
24888 "groupTitle": "Sms_Transfer_Reports"
24892 "url": "/api/sms/reports/transfer/describe",
24893 "title": "Gets table info about Sms Transfer Reports",
24896 "title": "Example usage:",
24897 "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
24901 "name": "DescribeSms_Transfer_Reports",
24902 "group": "Sms_Transfer_Reports",
24903 "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>",
24904 "version": "0.0.0",
24905 "filename": "server/api/smsTransferReport/index.js",
24906 "groupTitle": "Sms_Transfer_Reports"
24910 "url": "/api/sms/reports/transfer",
24911 "title": "Gets a list of Sms Transfer Reports",
24914 "title": "Example usage:",
24915 "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24919 "name": "GetSms_Transfer_Reports",
24920 "group": "Sms_Transfer_Reports",
24921 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24922 "version": "0.0.0",
24923 "filename": "server/api/smsTransferReport/index.js",
24924 "groupTitle": "Sms_Transfer_Reports"
24928 "url": "/api/sms/reports/transfer/{id}",
24929 "title": "Gets a single Sms Transfer Report",
24932 "title": "Example usage:",
24933 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24937 "name": "ShowSms_Transfer_Reports",
24938 "group": "Sms_Transfer_Reports",
24939 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24940 "version": "0.0.0",
24941 "filename": "server/api/smsTransferReport/index.js",
24942 "groupTitle": "Sms_Transfer_Reports"
24946 "url": "/api/sms/reports/transfer/{id}",
24947 "title": "Update an existing Sms Transfer Report",
24950 "title": "Example usage:",
24951 "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",
24955 "name": "updateSms_Transfer_Reports",
24956 "group": "Sms_Transfer_Reports",
24957 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24958 "version": "0.0.0",
24959 "filename": "server/api/smsTransferReport/index.js",
24960 "groupTitle": "Sms_Transfer_Reports"
24964 "url": "/api/sounds",
24965 "title": "Gets a list of Sounds",
24968 "title": "Example usage:",
24969 "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24973 "name": "GetSounds",
24975 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24976 "version": "0.0.0",
24977 "filename": "server/api/sound/index.js",
24978 "groupTitle": "Sounds"
24982 "url": "/api/sounds/{id}",
24983 "title": "Gets a single Sound",
24986 "title": "Example usage:",
24987 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24991 "name": "ShowSounds",
24993 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24994 "version": "0.0.0",
24995 "filename": "server/api/sound/index.js",
24996 "groupTitle": "Sounds"
25000 "url": "/api/sounds",
25001 "title": "Create a new sound",
25004 "title": "Example usage:",
25005 "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
25009 "name": "addSound",
25011 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25012 "version": "0.0.0",
25013 "filename": "server/api/sound/index.js",
25014 "groupTitle": "Sounds"
25018 "url": "/api/sounds/{id}",
25019 "title": "Deletes a sound",
25022 "title": "Example usage:",
25023 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
25027 "name": "destroySound",
25029 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25030 "version": "0.0.0",
25031 "filename": "server/api/sound/index.js",
25032 "groupTitle": "Sounds"
25036 "url": "/api/sounds/{id}/download",
25037 "title": "Download Sound",
25040 "title": "Example usage:",
25041 "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
25045 "name": "download",
25047 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25048 "version": "0.0.0",
25049 "filename": "server/api/sound/index.js",
25050 "groupTitle": "Sounds"
25054 "url": "/api/sounds",
25055 "title": "Update an existing new sound",
25058 "title": "Example usage:",
25059 "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
25063 "name": "updateSound",
25065 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25066 "version": "0.0.0",
25067 "filename": "server/api/sound/index.js",
25068 "groupTitle": "Sounds"
25072 "url": "/api/square/details/reports",
25073 "title": "Creates a new Square Detail Report",
25076 "title": "Example usage:",
25077 "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",
25081 "name": "CreateSquare_Detail_Reports",
25082 "group": "Square_Details_Reports",
25090 "field": "uniqueid",
25104 "field": "application",
25118 "field": "project_name",
25125 "field": "callerid",
25131 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25132 "version": "0.0.0",
25133 "filename": "server/api/squareReportDetail/index.js",
25134 "groupTitle": "Square_Details_Reports"
25138 "url": "/api/square/details/reports/{id}",
25139 "title": "Deletes a Square Detail Report",
25142 "title": "Example usage:",
25143 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
25147 "name": "DeleteSquare_Detail_Reports",
25148 "group": "Square_Details_Reports",
25149 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25150 "version": "0.0.0",
25151 "filename": "server/api/squareReportDetail/index.js",
25152 "groupTitle": "Square_Details_Reports"
25156 "url": "/api/square/details/reports/describe",
25157 "title": "Gets table info about Square Detail Reports",
25160 "title": "Example usage:",
25161 "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
25165 "name": "DescribeSquare_Detail_Reports",
25166 "group": "Square_Details_Reports",
25167 "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>",
25168 "version": "0.0.0",
25169 "filename": "server/api/squareReportDetail/index.js",
25170 "groupTitle": "Square_Details_Reports"
25174 "url": "/api/square/details/reports",
25175 "title": "Gets a list of Square Detail Reports",
25178 "title": "Example usage:",
25179 "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
25183 "name": "GetSquare_Detail_Reports",
25184 "group": "Square_Details_Reports",
25185 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25186 "version": "0.0.0",
25187 "filename": "server/api/squareReportDetail/index.js",
25188 "groupTitle": "Square_Details_Reports"
25192 "url": "/api/square/details/reports/{id}",
25193 "title": "Gets a single Square Detail Report",
25196 "title": "Example usage:",
25197 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
25201 "name": "ShowSquare_Detail_Reports",
25202 "group": "Square_Details_Reports",
25203 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25204 "version": "0.0.0",
25205 "filename": "server/api/squareReportDetail/index.js",
25206 "groupTitle": "Square_Details_Reports"
25210 "url": "/api/square/details/reports/{id}",
25211 "title": "Update an existing Square Detail Report",
25214 "title": "Example usage:",
25215 "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",
25219 "name": "updateSquare_Detail_Reports",
25220 "group": "Square_Details_Reports",
25221 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25222 "version": "0.0.0",
25223 "filename": "server/api/squareReportDetail/index.js",
25224 "groupTitle": "Square_Details_Reports"
25228 "url": "/api/square/messages",
25229 "title": "Creates a new Message",
25232 "title": "Example usage:",
25233 "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25237 "name": "CreateMessages",
25238 "group": "Square_Messages",
25246 "field": "uniqueid",
25264 "field": "direction",
25271 "field": "providerName",
25278 "field": "providerResponse",
25284 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25285 "version": "0.0.0",
25286 "filename": "server/api/squareMessage/index.js",
25287 "groupTitle": "Square_Messages"
25291 "url": "/api/square/messages/{id}",
25292 "title": "Deletes a Message",
25295 "title": "Example usage:",
25296 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
25300 "name": "DeleteMessages",
25301 "group": "Square_Messages",
25302 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25303 "version": "0.0.0",
25304 "filename": "server/api/squareMessage/index.js",
25305 "groupTitle": "Square_Messages"
25309 "url": "/api/square/messages",
25310 "title": "Gets a list of Messages",
25313 "title": "Example usage:",
25314 "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
25318 "name": "GetMessages",
25319 "group": "Square_Messages",
25320 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25321 "version": "0.0.0",
25322 "filename": "server/api/squareMessage/index.js",
25323 "groupTitle": "Square_Messages"
25327 "url": "/api/square/messages/{id}",
25328 "title": "Gets a single Message",
25331 "title": "Example usage:",
25332 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
25336 "name": "ShowMessages",
25337 "group": "Square_Messages",
25338 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25339 "version": "0.0.0",
25340 "filename": "server/api/squareMessage/index.js",
25341 "groupTitle": "Square_Messages"
25345 "url": "/api/square/messages/{id}",
25346 "title": "Update an existing Message",
25349 "title": "Example usage:",
25350 "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",
25354 "name": "updateMessages",
25355 "group": "Square_Messages",
25356 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25357 "version": "0.0.0",
25358 "filename": "server/api/squareMessage/index.js",
25359 "groupTitle": "Square_Messages"
25363 "url": "/api/square/odbc",
25364 "title": "Creates a new ODBC",
25367 "title": "Example usage:",
25368 "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25372 "name": "CreateODBCs",
25373 "group": "Square_ODBC",
25395 "field": "description",
25401 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25402 "version": "0.0.0",
25403 "filename": "server/api/squareOdbc/index.js",
25404 "groupTitle": "Square_ODBC"
25408 "url": "/api/square/odbc/{id}",
25409 "title": "Deletes a ODBC",
25412 "title": "Example usage:",
25413 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
25417 "name": "DeleteODBCs",
25418 "group": "Square_ODBC",
25419 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25420 "version": "0.0.0",
25421 "filename": "server/api/squareOdbc/index.js",
25422 "groupTitle": "Square_ODBC"
25426 "url": "/api/square/odbc",
25427 "title": "Gets a list of ODBCs",
25430 "title": "Example usage:",
25431 "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
25435 "name": "GetODBCs",
25436 "group": "Square_ODBC",
25437 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25438 "version": "0.0.0",
25439 "filename": "server/api/squareOdbc/index.js",
25440 "groupTitle": "Square_ODBC"
25444 "url": "/api/square/odbc/{id}",
25445 "title": "Gets a single ODBC",
25448 "title": "Example usage:",
25449 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
25453 "name": "ShowODBCs",
25454 "group": "Square_ODBC",
25455 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25456 "version": "0.0.0",
25457 "filename": "server/api/squareOdbc/index.js",
25458 "groupTitle": "Square_ODBC"
25462 "url": "/api/square/odbc/{id}/test",
25463 "title": "Test Odbc",
25466 "title": "Example usage:",
25467 "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
25472 "group": "Square_ODBC",
25473 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25474 "version": "0.0.0",
25475 "filename": "server/api/squareOdbc/index.js",
25476 "groupTitle": "Square_ODBC"
25480 "url": "/api/square/odbc/{id}",
25481 "title": "Update an existing ODBC",
25484 "title": "Example usage:",
25485 "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",
25489 "name": "updateODBCs",
25490 "group": "Square_ODBC",
25491 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25492 "version": "0.0.0",
25493 "filename": "server/api/squareOdbc/index.js",
25494 "groupTitle": "Square_ODBC"
25498 "url": "/api/square/projects",
25499 "title": "Creates a new Project",
25502 "title": "Example usage:",
25503 "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25507 "name": "CreateProjects",
25508 "group": "Square_Projects",
25523 "field": "description",
25537 "field": "preproduction",
25544 "field": "production",
25551 "field": "savedAt",
25558 "field": "publishedAt",
25564 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25565 "version": "0.0.0",
25566 "filename": "server/api/squareProject/index.js",
25567 "groupTitle": "Square_Projects"
25571 "url": "/api/square/projects/{id}",
25572 "title": "Deletes a Project",
25575 "title": "Example usage:",
25576 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
25580 "name": "DeleteProjects",
25581 "group": "Square_Projects",
25582 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25583 "version": "0.0.0",
25584 "filename": "server/api/squareProject/index.js",
25585 "groupTitle": "Square_Projects"
25589 "url": "/api/square/projects",
25590 "title": "Gets a list of Projects",
25593 "title": "Example usage:",
25594 "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
25598 "name": "GetProjects",
25599 "group": "Square_Projects",
25600 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25601 "version": "0.0.0",
25602 "filename": "server/api/squareProject/index.js",
25603 "groupTitle": "Square_Projects"
25607 "url": "/api/square/projects/{id}",
25608 "title": "Gets a single Project",
25611 "title": "Example usage:",
25612 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
25616 "name": "ShowProjects",
25617 "group": "Square_Projects",
25618 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25619 "version": "0.0.0",
25620 "filename": "server/api/squareProject/index.js",
25621 "groupTitle": "Square_Projects"
25625 "url": "/api/square/projects/{id}",
25626 "title": "Update an existing Project",
25629 "title": "Example usage:",
25630 "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",
25634 "name": "updateProjects",
25635 "group": "Square_Projects",
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/squareProject/index.js",
25639 "groupTitle": "Square_Projects"
25643 "url": "/api/square/recordings",
25644 "title": "Creates a new Recording",
25647 "title": "Example usage:",
25648 "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25652 "name": "CreateRecordings",
25653 "group": "Square_Recordings",
25661 "field": "uniqueid",
25668 "field": "callerid",
25675 "field": "calleridname",
25682 "field": "context",
25689 "field": "extension",
25696 "field": "priority",
25703 "field": "accountcode",
25717 "field": "projectName",
25724 "field": "saveName",
25731 "field": "filename",
25738 "field": "savePath",
25751 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25752 "version": "0.0.0",
25753 "filename": "server/api/squareRecording/index.js",
25754 "groupTitle": "Square_Recordings"
25758 "url": "/api/square/recordings",
25759 "title": "Gets a list of Recordings",
25762 "title": "Example usage:",
25763 "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
25767 "name": "GetRecordings",
25768 "group": "Square_Recordings",
25769 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25770 "version": "0.0.0",
25771 "filename": "server/api/squareRecording/index.js",
25772 "groupTitle": "Square_Recordings"
25776 "url": "/api/square/recordings/{id}",
25777 "title": "Gets a single Recording",
25780 "title": "Example usage:",
25781 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
25785 "name": "ShowRecordings",
25786 "group": "Square_Recordings",
25787 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25788 "version": "0.0.0",
25789 "filename": "server/api/squareRecording/index.js",
25790 "groupTitle": "Square_Recordings"
25794 "url": "/api/square/recordings/{id}",
25795 "title": "Delete recording",
25798 "title": "Example usage:",
25799 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",
25804 "group": "Square_Recordings",
25805 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25806 "version": "0.0.0",
25807 "filename": "server/api/squareRecording/index.js",
25808 "groupTitle": "Square_Recordings"
25812 "url": "/api/square/recordings/{id}/download",
25813 "title": "Download Recording",
25816 "title": "Example usage:",
25817 "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
25821 "name": "download",
25822 "group": "Square_Recordings",
25823 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25824 "version": "0.0.0",
25825 "filename": "server/api/squareRecording/index.js",
25826 "groupTitle": "Square_Recordings"
25830 "url": "/api/square/recordings/{id}",
25831 "title": "Update an existing Recording",
25834 "title": "Example usage:",
25835 "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",
25839 "name": "updateRecordings",
25840 "group": "Square_Recordings",
25841 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25842 "version": "0.0.0",
25843 "filename": "server/api/squareRecording/index.js",
25844 "groupTitle": "Square_Recordings"
25848 "url": "/api/square/reports",
25849 "title": "Creates a new Square Report",
25852 "title": "Example usage:",
25853 "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25857 "name": "CreateSquare_Reports",
25858 "group": "Square_Reports",
25866 "field": "network",
25873 "field": "network_script",
25880 "field": "request",
25887 "field": "channel",
25894 "field": "language",
25908 "field": "uniqueid",
25915 "field": "version",
25922 "field": "callerid",
25929 "field": "calleridname",
25936 "field": "callingpres",
25943 "field": "callingani2",
25950 "field": "callington",
25957 "field": "callingtns",
25978 "field": "context",
25985 "field": "extension",
25992 "field": "priority",
25999 "field": "enhanced",
26006 "field": "accountcode",
26013 "field": "threadid",
26020 "field": "project_name",
26034 "field": "leaveAt",
26047 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26048 "version": "0.0.0",
26049 "filename": "server/api/squareReport/index.js",
26050 "groupTitle": "Square_Reports"
26054 "url": "/api/square/reports/{id}",
26055 "title": "Deletes a Square Report",
26058 "title": "Example usage:",
26059 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
26063 "name": "DeleteSquare_Reports",
26064 "group": "Square_Reports",
26065 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26066 "version": "0.0.0",
26067 "filename": "server/api/squareReport/index.js",
26068 "groupTitle": "Square_Reports"
26072 "url": "/api/square/reports/describe",
26073 "title": "Gets table info about Square Reports",
26076 "title": "Example usage:",
26077 "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
26081 "name": "DescribeSquare_Reports",
26082 "group": "Square_Reports",
26083 "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>",
26084 "version": "0.0.0",
26085 "filename": "server/api/squareReport/index.js",
26086 "groupTitle": "Square_Reports"
26090 "url": "/api/square/reports",
26091 "title": "Gets a list of Square Reports",
26094 "title": "Example usage:",
26095 "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
26099 "name": "GetSquare_Reports",
26100 "group": "Square_Reports",
26101 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26102 "version": "0.0.0",
26103 "filename": "server/api/squareReport/index.js",
26104 "groupTitle": "Square_Reports"
26108 "url": "/api/square/reports/{id}",
26109 "title": "Gets a single Square Report",
26112 "title": "Example usage:",
26113 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
26117 "name": "ShowSquare_Reports",
26118 "group": "Square_Reports",
26119 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26120 "version": "0.0.0",
26121 "filename": "server/api/squareReport/index.js",
26122 "groupTitle": "Square_Reports"
26126 "url": "/api/square/reports/{id}",
26127 "title": "Update an existing Square Report",
26130 "title": "Example usage:",
26131 "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",
26135 "name": "updateSquare_Reports",
26136 "group": "Square_Reports",
26137 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26138 "version": "0.0.0",
26139 "filename": "server/api/squareReport/index.js",
26140 "groupTitle": "Square_Reports"
26144 "url": "/api/integrations/sugarcrm/configurations",
26145 "title": "Creates a new SugarCRM Configuration",
26148 "title": "Example usage:",
26149 "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",
26153 "name": "CreateSugarCRM_Configurations",
26154 "group": "SugarCRM_Configurations",
26169 "field": "description",
26175 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26176 "version": "0.0.0",
26177 "filename": "server/api/intSugarcrmConfiguration/index.js",
26178 "groupTitle": "SugarCRM_Configurations"
26182 "url": "/api/integrations/sugarcrm/configurations/{id}",
26183 "title": "Deletes a SugarCRM Configuration",
26186 "title": "Example usage:",
26187 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
26191 "name": "DeleteSugarCRM_Configurations",
26192 "group": "SugarCRM_Configurations",
26193 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26194 "version": "0.0.0",
26195 "filename": "server/api/intSugarcrmConfiguration/index.js",
26196 "groupTitle": "SugarCRM_Configurations"
26200 "url": "/api/integrations/sugarcrm/configurations",
26201 "title": "Gets a list of SugarCRM Configurations",
26204 "title": "Example usage:",
26205 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
26209 "name": "GetSugarCRM_Configurations",
26210 "group": "SugarCRM_Configurations",
26211 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26212 "version": "0.0.0",
26213 "filename": "server/api/intSugarcrmConfiguration/index.js",
26214 "groupTitle": "SugarCRM_Configurations"
26218 "url": "/api/integrations/sugarcrm/configurations/{id}",
26219 "title": "Gets a single SugarCRM Configuration",
26222 "title": "Example usage:",
26223 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
26227 "name": "ShowSugarCRM_Configurations",
26228 "group": "SugarCRM_Configurations",
26229 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26230 "version": "0.0.0",
26231 "filename": "server/api/intSugarcrmConfiguration/index.js",
26232 "groupTitle": "SugarCRM_Configurations"
26236 "url": "/api/integrations/sugarcrm/configurations/{id}",
26237 "title": "Update an existing SugarCRM Configuration",
26240 "title": "Example usage:",
26241 "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",
26245 "name": "updateSugarCRM_Configurations",
26246 "group": "SugarCRM_Configurations",
26247 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26248 "version": "0.0.0",
26249 "filename": "server/api/intSugarcrmConfiguration/index.js",
26250 "groupTitle": "SugarCRM_Configurations"
26254 "url": "/api/integrations/sugarcrm/accounts",
26255 "title": "Creates a new Sugarcrm Account",
26258 "title": "Example usage:",
26259 "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",
26263 "name": "CreateSugarcrm_Accounts",
26264 "group": "Sugarcrm_Accounts",
26279 "field": "description",
26286 "field": "username",
26293 "field": "password",
26300 "field": "remoteUri",
26307 "field": "serverUrl",
26313 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26314 "version": "0.0.0",
26315 "filename": "server/api/intSugarcrmAccount/index.js",
26316 "groupTitle": "Sugarcrm_Accounts"
26320 "url": "/api/integrations/sugarcrm/accounts/{id}",
26321 "title": "Deletes a Sugarcrm Account",
26324 "title": "Example usage:",
26325 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
26329 "name": "DeleteSugarcrm_Accounts",
26330 "group": "Sugarcrm_Accounts",
26331 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26332 "version": "0.0.0",
26333 "filename": "server/api/intSugarcrmAccount/index.js",
26334 "groupTitle": "Sugarcrm_Accounts"
26338 "url": "/api/integrations/sugarcrm/accounts",
26339 "title": "Gets a list of Sugarcrm Accounts",
26342 "title": "Example usage:",
26343 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
26347 "name": "GetSugarcrm_Accounts",
26348 "group": "Sugarcrm_Accounts",
26349 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26350 "version": "0.0.0",
26351 "filename": "server/api/intSugarcrmAccount/index.js",
26352 "groupTitle": "Sugarcrm_Accounts"
26356 "url": "/api/integrations/sugarcrm/accounts/{id}",
26357 "title": "Gets a single Sugarcrm Account",
26360 "title": "Example usage:",
26361 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
26365 "name": "ShowSugarcrm_Accounts",
26366 "group": "Sugarcrm_Accounts",
26367 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26368 "version": "0.0.0",
26369 "filename": "server/api/intSugarcrmAccount/index.js",
26370 "groupTitle": "Sugarcrm_Accounts"
26374 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
26375 "title": "Creates new configuration",
26378 "title": "Example usage:",
26379 "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",
26383 "name": "addConfiguration",
26384 "group": "Sugarcrm_Accounts",
26385 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26386 "version": "0.0.0",
26387 "filename": "server/api/intSugarcrmAccount/index.js",
26388 "groupTitle": "Sugarcrm_Accounts"
26392 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
26393 "title": "Gets account configurations",
26396 "title": "Example usage:",
26397 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
26401 "name": "getConfigurations",
26402 "group": "Sugarcrm_Accounts",
26403 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26404 "version": "0.0.0",
26405 "filename": "server/api/intSugarcrmAccount/index.js",
26406 "groupTitle": "Sugarcrm_Accounts"
26410 "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
26411 "title": "Gets account fields",
26414 "title": "Example usage:",
26415 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
26419 "name": "getFields",
26420 "group": "Sugarcrm_Accounts",
26421 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26422 "version": "0.0.0",
26423 "filename": "server/api/intSugarcrmAccount/index.js",
26424 "groupTitle": "Sugarcrm_Accounts"
26428 "url": "/api/integrations/sugarcrm/accounts/{id}",
26429 "title": "Update an existing Sugarcrm Account",
26432 "title": "Example usage:",
26433 "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",
26437 "name": "updateSugarcrm_Accounts",
26438 "group": "Sugarcrm_Accounts",
26439 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26440 "version": "0.0.0",
26441 "filename": "server/api/intSugarcrmAccount/index.js",
26442 "groupTitle": "Sugarcrm_Accounts"
26446 "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
26447 "title": "Gets configurations descriptions",
26450 "title": "Example usage:",
26451 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
26455 "name": "getDescriptions",
26456 "group": "Sugarcrm_Configurations",
26457 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26458 "version": "0.0.0",
26459 "filename": "server/api/intSugarcrmConfiguration/index.js",
26460 "groupTitle": "Sugarcrm_Configurations"
26464 "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
26465 "title": "Gets configurations fields",
26468 "title": "Example usage:",
26469 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
26473 "name": "getFields",
26474 "group": "Sugarcrm_Configurations",
26475 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26476 "version": "0.0.0",
26477 "filename": "server/api/intSugarcrmConfiguration/index.js",
26478 "groupTitle": "Sugarcrm_Configurations"
26482 "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
26483 "title": "Gets configurations subjects",
26486 "title": "Example usage:",
26487 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
26491 "name": "getSubjects",
26492 "group": "Sugarcrm_Configurations",
26493 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26494 "version": "0.0.0",
26495 "filename": "server/api/intSugarcrmConfiguration/index.js",
26496 "groupTitle": "Sugarcrm_Configurations"
26500 "url": "/api/integrations/sugarcrm/fields",
26501 "title": "Creates a new Sugarcrm Field",
26504 "title": "Example usage:",
26505 "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",
26509 "name": "CreateSugarcrm_Fields",
26510 "group": "Sugarcrm_Fields",
26520 "\"customVariable\"",
26532 "field": "content",
26548 "\"customVariable\""
26551 "field": "keyType",
26558 "field": "keyContent",
26565 "field": "idField",
26572 "field": "nameField",
26579 "field": "customField",
26586 "field": "variableName",
26592 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26593 "version": "0.0.0",
26594 "filename": "server/api/intSugarcrmField/index.js",
26595 "groupTitle": "Sugarcrm_Fields"
26599 "url": "/api/integrations/sugarcrm/fields/{id}",
26600 "title": "Deletes a Sugarcrm Field",
26603 "title": "Example usage:",
26604 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
26608 "name": "DeleteSugarcrm_Fields",
26609 "group": "Sugarcrm_Fields",
26610 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26611 "version": "0.0.0",
26612 "filename": "server/api/intSugarcrmField/index.js",
26613 "groupTitle": "Sugarcrm_Fields"
26617 "url": "/api/integrations/sugarcrm/fields",
26618 "title": "Gets a list of Sugarcrm Fields",
26621 "title": "Example usage:",
26622 "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
26626 "name": "GetSugarcrm_Fields",
26627 "group": "Sugarcrm_Fields",
26628 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26629 "version": "0.0.0",
26630 "filename": "server/api/intSugarcrmField/index.js",
26631 "groupTitle": "Sugarcrm_Fields"
26635 "url": "/api/integrations/sugarcrm/fields/{id}",
26636 "title": "Gets a single Sugarcrm Field",
26639 "title": "Example usage:",
26640 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
26644 "name": "ShowSugarcrm_Fields",
26645 "group": "Sugarcrm_Fields",
26646 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26647 "version": "0.0.0",
26648 "filename": "server/api/intSugarcrmField/index.js",
26649 "groupTitle": "Sugarcrm_Fields"
26653 "url": "/api/integrations/sugarcrm/fields/{id}",
26654 "title": "Update an existing Sugarcrm Field",
26657 "title": "Example usage:",
26658 "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",
26662 "name": "updateSugarcrm_Fields",
26663 "group": "Sugarcrm_Fields",
26664 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26665 "version": "0.0.0",
26666 "filename": "server/api/intSugarcrmField/index.js",
26667 "groupTitle": "Sugarcrm_Fields"
26671 "url": "/api/system",
26672 "title": "Gets system information",
26675 "title": "Example usage:",
26676 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26680 "name": "GetSystemInformation",
26681 "group": "System_Information",
26682 "description": "<p>Motion returns the system information.</p>",
26683 "version": "0.0.0",
26684 "filename": "server/api/system/index.js",
26685 "groupTitle": "System_Information"
26689 "url": "/api/system/process",
26690 "title": "Gets system information",
26693 "title": "Example usage:",
26694 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26698 "name": "GetSystemInformation",
26699 "group": "System_Information",
26700 "description": "<p>Motion returns the system information.</p>",
26701 "version": "0.0.0",
26702 "filename": "server/api/system/index.js",
26703 "groupTitle": "System_Information"
26707 "url": "/api/tags",
26708 "title": "Creates a new Tag",
26711 "title": "Example usage:",
26712 "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26716 "name": "CreateTags",
26739 "field": "description",
26745 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26746 "version": "0.0.0",
26747 "filename": "server/api/tag/index.js",
26748 "groupTitle": "Tags"
26752 "url": "/api/tags/{id}",
26753 "title": "Deletes a Tag",
26756 "title": "Example usage:",
26757 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
26761 "name": "DeleteTags",
26763 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26764 "version": "0.0.0",
26765 "filename": "server/api/tag/index.js",
26766 "groupTitle": "Tags"
26770 "url": "/api/tags/describe",
26771 "title": "Gets table info about Accounts",
26774 "title": "Example usage:",
26775 "content": "curl https://{domain}/api/tags/describe -v -u {name}:{password}",
26779 "name": "DescribeTags",
26781 "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>",
26782 "version": "0.0.0",
26783 "filename": "server/api/tag/index.js",
26784 "groupTitle": "Tags"
26788 "url": "/api/tags",
26789 "title": "Gets a list of Tags",
26792 "title": "Example usage:",
26793 "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
26799 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26800 "version": "0.0.0",
26801 "filename": "server/api/tag/index.js",
26802 "groupTitle": "Tags"
26806 "url": "/api/tags/{id}",
26807 "title": "Gets a single Tag",
26810 "title": "Example usage:",
26811 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
26815 "name": "ShowTags",
26817 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26818 "version": "0.0.0",
26819 "filename": "server/api/tag/index.js",
26820 "groupTitle": "Tags"
26824 "url": "/api/tags/{id}",
26825 "title": "Update an existing Tag",
26828 "title": "Example usage:",
26829 "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26833 "name": "updateTags",
26835 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26836 "version": "0.0.0",
26837 "filename": "server/api/tag/index.js",
26838 "groupTitle": "Tags"
26842 "url": "/api/teams/{id}/queues",
26843 "title": "Add queues to a team",
26846 "title": "Example usage:",
26847 "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26851 "name": "AddQueues",
26853 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26854 "version": "0.0.0",
26855 "filename": "server/api/team/index.js",
26856 "groupTitle": "Teams"
26860 "url": "/api/teams",
26861 "title": "Creates a new Team",
26864 "title": "Example usage:",
26865 "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26869 "name": "CreateTeams",
26885 "field": "description",
26891 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26892 "version": "0.0.0",
26893 "filename": "server/api/team/index.js",
26894 "groupTitle": "Teams"
26898 "url": "/api/teams/{id}",
26899 "title": "Deletes a Team",
26902 "title": "Example usage:",
26903 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26907 "name": "DeleteTeams",
26909 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26910 "version": "0.0.0",
26911 "filename": "server/api/team/index.js",
26912 "groupTitle": "Teams"
26916 "url": "/api/teams/{id}/users",
26917 "title": "Gets agents from team",
26920 "title": "Example usage:",
26921 "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26925 "name": "GetAgents",
26927 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26928 "version": "0.0.0",
26929 "filename": "server/api/team/index.js",
26930 "groupTitle": "Teams"
26934 "url": "/api/teams/{id}/queues?channel={channel}",
26935 "title": "Gets Queues list",
26938 "title": "Example usage:",
26939 "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26943 "name": "GetQueues",
26945 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26946 "version": "0.0.0",
26947 "filename": "server/api/team/index.js",
26948 "groupTitle": "Teams"
26952 "url": "/api/teams",
26953 "title": "Gets a list of Teams",
26956 "title": "Example usage:",
26957 "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26961 "name": "GetTeams",
26963 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26964 "version": "0.0.0",
26965 "filename": "server/api/team/index.js",
26966 "groupTitle": "Teams"
26970 "url": "/api/teams/{id}/users",
26971 "title": "Removes agents from a team",
26974 "title": "Example usage:",
26975 "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26979 "name": "RemoveAgents",
26981 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26982 "version": "0.0.0",
26983 "filename": "server/api/team/index.js",
26984 "groupTitle": "Teams"
26988 "url": "/api/teams/{id}/queues",
26989 "title": "Remove queues to a team",
26992 "title": "Example usage:",
26993 "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26997 "name": "RemoveQueues",
26999 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27000 "version": "0.0.0",
27001 "filename": "server/api/team/index.js",
27002 "groupTitle": "Teams"
27006 "url": "/api/whatsapp/queues/{id}/teams",
27007 "title": "Remove teams from a queue",
27010 "title": "Example usage:",
27011 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27015 "name": "RemoveTeams",
27017 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27018 "version": "0.0.0",
27019 "filename": "server/api/whatsappQueue/index.js",
27020 "groupTitle": "Teams"
27024 "url": "/api/voice/queues/{id}/teams",
27025 "title": "Remove teams from a queue",
27028 "title": "Example usage:",
27029 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27033 "name": "RemoveTeams",
27035 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27036 "version": "0.0.0",
27037 "filename": "server/api/voiceQueue/index.js",
27038 "groupTitle": "Teams"
27042 "url": "/api/sms/queues/{id}/teams",
27043 "title": "Remove teams from a queue",
27046 "title": "Example usage:",
27047 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27051 "name": "RemoveTeams",
27053 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27054 "version": "0.0.0",
27055 "filename": "server/api/smsQueue/index.js",
27056 "groupTitle": "Teams"
27060 "url": "/api/voice/Prefixes/{id}/teams",
27061 "title": "Remove teams from a voice prefix",
27064 "title": "Example usage:",
27065 "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X DELETE",
27069 "name": "RemoveTeams",
27071 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27072 "version": "0.0.0",
27073 "filename": "server/api/voicePrefix/index.js",
27074 "groupTitle": "Teams"
27078 "url": "/api/chat/queues/{id}/teams",
27079 "title": "Remove teams from a queue",
27082 "title": "Example usage:",
27083 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27087 "name": "RemoveTeams",
27089 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27090 "version": "0.0.0",
27091 "filename": "server/api/chatQueue/index.js",
27092 "groupTitle": "Teams"
27096 "url": "/api/mail/queues/{id}/teams",
27097 "title": "Remove teams from a queue",
27100 "title": "Example usage:",
27101 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27105 "name": "RemoveTeams",
27107 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27108 "version": "0.0.0",
27109 "filename": "server/api/mailQueue/index.js",
27110 "groupTitle": "Teams"
27114 "url": "/api/fax/queues/{id}/teams",
27115 "title": "Remove teams from a queue",
27118 "title": "Example usage:",
27119 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27123 "name": "RemoveTeams",
27125 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27126 "version": "0.0.0",
27127 "filename": "server/api/faxQueue/index.js",
27128 "groupTitle": "Teams"
27132 "url": "/api/openchannel/queues/{id}/teams",
27133 "title": "Remove teams from a queue",
27136 "title": "Example usage:",
27137 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27141 "name": "RemoveTeams",
27143 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27144 "version": "0.0.0",
27145 "filename": "server/api/openchannelQueue/index.js",
27146 "groupTitle": "Teams"
27150 "url": "/api/teams/{id}",
27151 "title": "Gets a single Team",
27154 "title": "Example usage:",
27155 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
27159 "name": "ShowTeams",
27161 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27162 "version": "0.0.0",
27163 "filename": "server/api/team/index.js",
27164 "groupTitle": "Teams"
27168 "url": "/api/teams/{id}/users",
27169 "title": "Adds agents to a team",
27172 "title": "Example usage:",
27173 "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27177 "name": "addAgents",
27179 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27180 "version": "0.0.0",
27181 "filename": "server/api/team/index.js",
27182 "groupTitle": "Teams"
27186 "url": "/api/teams/{id}",
27187 "title": "Update an existing Team",
27190 "title": "Example usage:",
27191 "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27195 "name": "updateTeams",
27197 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27198 "version": "0.0.0",
27199 "filename": "server/api/team/index.js",
27200 "groupTitle": "Teams"
27204 "url": "/api/templates",
27205 "title": "Creates a new Template",
27208 "title": "Example usage:",
27209 "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27213 "name": "CreateTemplates",
27214 "group": "Templates",
27229 "field": "description",
27242 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27243 "version": "0.0.0",
27244 "filename": "server/api/template/index.js",
27245 "groupTitle": "Templates"
27249 "url": "/api/templates/{id}",
27250 "title": "Deletes a Template",
27253 "title": "Example usage:",
27254 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
27258 "name": "DeleteTemplates",
27259 "group": "Templates",
27260 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27261 "version": "0.0.0",
27262 "filename": "server/api/template/index.js",
27263 "groupTitle": "Templates"
27267 "url": "/api/templates",
27268 "title": "Gets a list of Templates",
27271 "title": "Example usage:",
27272 "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
27276 "name": "GetTemplates",
27277 "group": "Templates",
27278 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27279 "version": "0.0.0",
27280 "filename": "server/api/template/index.js",
27281 "groupTitle": "Templates"
27285 "url": "/api/templates/{id}",
27286 "title": "Gets a single Template",
27289 "title": "Example usage:",
27290 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
27294 "name": "ShowTemplates",
27295 "group": "Templates",
27296 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27297 "version": "0.0.0",
27298 "filename": "server/api/template/index.js",
27299 "groupTitle": "Templates"
27303 "url": "/api/templates/{id}",
27304 "title": "Update an existing Template",
27307 "title": "Example usage:",
27308 "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27312 "name": "updateTemplates",
27313 "group": "Templates",
27314 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27315 "version": "0.0.0",
27316 "filename": "server/api/template/index.js",
27317 "groupTitle": "Templates"
27321 "url": "/api/triggers",
27322 "title": "Creates a new Trigger",
27325 "title": "Example usage:",
27326 "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27330 "name": "CreateTriggers",
27331 "group": "Triggers",
27346 "field": "channel",
27353 "field": "description",
27366 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27367 "version": "0.0.0",
27368 "filename": "server/api/trigger/index.js",
27369 "groupTitle": "Triggers"
27373 "url": "/api/triggers/{id}",
27374 "title": "Deletes a Trigger",
27377 "title": "Example usage:",
27378 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
27382 "name": "DeleteTriggers",
27383 "group": "Triggers",
27384 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27385 "version": "0.0.0",
27386 "filename": "server/api/trigger/index.js",
27387 "groupTitle": "Triggers"
27391 "url": "/api/triggers",
27392 "title": "Gets a list of Triggers",
27395 "title": "Example usage:",
27396 "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
27400 "name": "GetTriggers",
27401 "group": "Triggers",
27402 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27403 "version": "0.0.0",
27404 "filename": "server/api/trigger/index.js",
27405 "groupTitle": "Triggers"
27409 "url": "/api/triggers/{id}",
27410 "title": "Gets a single Trigger",
27413 "title": "Example usage:",
27414 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
27418 "name": "ShowTriggers",
27419 "group": "Triggers",
27420 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27421 "version": "0.0.0",
27422 "filename": "server/api/trigger/index.js",
27423 "groupTitle": "Triggers"
27427 "url": "/api/triggers/{id}/actions",
27428 "title": "Creates new actions",
27431 "title": "Example usage:",
27432 "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27436 "name": "addAction",
27437 "group": "Triggers",
27453 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
27460 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
27467 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
27474 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
27507 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27508 "version": "0.0.0",
27509 "filename": "server/api/trigger/index.js",
27510 "groupTitle": "Triggers"
27514 "url": "/api/triggers/{id}/all_conditions",
27515 "title": "Creates a new \"AND\"condition",
27518 "title": "Example usage:",
27519 "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",
27523 "name": "addAllCondition",
27524 "group": "Triggers",
27546 "field": "operator",
27559 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27560 "version": "0.0.0",
27561 "filename": "server/api/trigger/index.js",
27562 "groupTitle": "Triggers"
27566 "url": "/api/triggers/{id}/any_conditions",
27567 "title": "Creates a new \"OR\"condition",
27570 "title": "Example usage:",
27571 "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",
27575 "name": "addAnyCondition",
27576 "group": "Triggers",
27598 "field": "operator",
27611 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27612 "version": "0.0.0",
27613 "filename": "server/api/trigger/index.js",
27614 "groupTitle": "Triggers"
27618 "url": "/api/triggers/{id}/actions",
27619 "title": "Gets Trigger Actions",
27622 "title": "Example usage:",
27623 "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
27627 "name": "getActions",
27628 "group": "Triggers",
27629 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27630 "version": "0.0.0",
27631 "filename": "server/api/trigger/index.js",
27632 "groupTitle": "Triggers"
27636 "url": "/api/triggers/{id}/all_conditions",
27637 "title": "Gets \"AND\" Trigger Conditions",
27640 "title": "Example usage:",
27641 "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
27645 "name": "getAllConditions",
27646 "group": "Triggers",
27647 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27648 "version": "0.0.0",
27649 "filename": "server/api/trigger/index.js",
27650 "groupTitle": "Triggers"
27654 "url": "/api/triggers/{id}/any_conditions",
27655 "title": "Gets \"OR\" Trigger Conditions",
27658 "title": "Example usage:",
27659 "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
27663 "name": "getAnyConditions",
27664 "group": "Triggers",
27665 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27666 "version": "0.0.0",
27667 "filename": "server/api/trigger/index.js",
27668 "groupTitle": "Triggers"
27672 "url": "/api/triggers/{id}",
27673 "title": "Update an existing Trigger",
27676 "title": "Example usage:",
27677 "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27681 "name": "updateTriggers",
27682 "group": "Triggers",
27683 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27684 "version": "0.0.0",
27685 "filename": "server/api/trigger/index.js",
27686 "groupTitle": "Triggers"
27690 "url": "/api/trunks/clone",
27691 "title": "Clone an existing Trunk",
27694 "title": "Example usage:",
27695 "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27699 "name": "CloneTrunks",
27701 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27702 "version": "0.0.0",
27703 "filename": "server/api/trunk/index.js",
27704 "groupTitle": "Trunks"
27708 "url": "/api/trunks",
27709 "title": "Create a new trunk",
27712 "title": "Example usage:",
27713 "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
27745 "field": "context",
27752 "\"ALLOWED_NOT_SCREENED\"",
27753 "\"ALLOWED_PASSED_SCREEN\"",
27754 "\"ALLOWED_FAILED_SCREEN\"",
27756 "\"PROHIB_NOT_SCREENED\"",
27757 "\"PROHIB_PASSED_SCREEN\"",
27758 "\"PROHIB_FAILED_SCREEN\"",
27762 "field": "callingpres",
27790 "field": "md5secret",
27797 "field": "remotesecret",
27804 "field": "transport",
27805 "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"
27818 "field": "dtmfmode",
27832 "field": "directmedia",
27843 "field": "directrtpsetup",
27850 "field": "directmediapermit",
27857 "field": "directmediadeny",
27865 "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"
27871 "field": "callgroup",
27878 "field": "namedcallgroup",
27885 "field": "pickupgroup",
27892 "field": "namedpickupgroup",
27899 "field": "language",
27906 "field": "tonezone",
27913 "field": "disallow",
27921 "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "alaw"]</p>"
27931 "field": "autoframing",
27938 "field": "insecure",
27939 "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"
27949 "field": "trustrpid",
27960 "field": "trust_id_outbound",
27972 "field": "progressinband",
27983 "field": "promiscredir",
27994 "field": "useclientcode",
28001 "field": "accountcode",
28015 "field": "callerid",
28022 "field": "amaflags",
28033 "field": "callcounter",
28040 "field": "busylevel",
28051 "field": "allowoverlap",
28062 "field": "allowsubscribe",
28073 "field": "allowtransfer",
28084 "field": "ignoresdpversion",
28091 "field": "subscribecontext",
28098 "field": "template",
28110 "field": "videosupport",
28117 "field": "maxcallbitrate",
28128 "field": "rfc2833compensate",
28135 "field": "mailbox",
28147 "field": "session_timers",
28154 "field": "session_expires",
28161 "field": "session_minse",
28172 "field": "session_refresher",
28179 "field": "t38pt_usertpsource",
28186 "field": "regexten",
28193 "field": "fromdomain",
28200 "field": "fromuser",
28218 "field": "qualify",
28225 "field": "keepalive",
28232 "field": "defaultip",
28239 "field": "defaultuser",
28246 "field": "rtptimeout",
28253 "field": "rtpholdtimeout",
28260 "field": "rtpkeepalive",
28272 "field": "sendrpid",
28279 "field": "outboundproxy",
28286 "field": "callbackextension",
28293 "field": "timert1",
28307 "field": "qualifyfreq",
28314 "field": "contactpermit",
28321 "field": "contactdeny",
28328 "field": "contactacl",
28335 "field": "unsolicited_mailbox",
28342 "field": "use_q850_reason",
28349 "field": "maxforwards",
28360 "field": "encryption",
28382 "field": "force_avp",
28393 "field": "icesupport",
28404 "field": "dtlsenable",
28417 "field": "dtlsverify",
28424 "field": "dtlsrekey",
28431 "field": "dtlscertfile",
28438 "field": "dtlsprivatekey",
28445 "field": "dtlscipher",
28452 "field": "dtlscafile",
28459 "field": "dtlscapath",
28471 "field": "dtlssetup",
28478 "field": "dtlsfingerprint",
28489 "field": "usereqphone",
28496 "field": "recordonfeature",
28503 "field": "recordofffeature",
28510 "field": "call_limit",
28521 "field": "registertrying",
28532 "field": "subscribemwi",
28539 "field": "vmexten",
28546 "field": "mohinterpret",
28553 "field": "mohsuggest",
28560 "field": "parkinglot",
28567 "field": "description",
28588 "field": "canreinvite",
28595 "field": "registry",
28602 "field": "otherFields",
28616 "field": "t38pt_udptl",
28622 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28623 "version": "0.0.0",
28624 "filename": "server/api/trunk/index.js",
28625 "groupTitle": "Trunks"
28629 "url": "/api/trunks/{id}",
28630 "title": "Deletes a trunk",
28633 "title": "Example usage:",
28634 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
28640 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28641 "version": "0.0.0",
28642 "filename": "server/api/trunk/index.js",
28643 "groupTitle": "Trunks"
28647 "url": "/api/trunks",
28648 "title": "Gets a list of Trunks",
28651 "title": "Example usage:",
28652 "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
28656 "name": "GetTrunks",
28658 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28659 "version": "0.0.0",
28660 "filename": "server/api/trunk/index.js",
28661 "groupTitle": "Trunks"
28665 "url": "/api/trunks/{id}",
28666 "title": "Gets a single Trunk",
28669 "title": "Example usage:",
28670 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
28674 "name": "ShowTrunks",
28676 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28677 "version": "0.0.0",
28678 "filename": "server/api/trunk/index.js",
28679 "groupTitle": "Trunks"
28683 "url": "/api/trunks/{id}",
28684 "title": "Update an existing trunk",
28687 "title": "Example usage:",
28688 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
28694 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28695 "version": "0.0.0",
28696 "filename": "server/api/trunk/index.js",
28697 "groupTitle": "Trunks"
28701 "url": "/api/userNotifications",
28702 "title": "Send notification to user",
28705 "title": "Example usage:",
28706 "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28711 "group": "UserNotifications",
28712 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28713 "version": "0.0.0",
28714 "filename": "server/api/userNotification/index.js",
28715 "groupTitle": "UserNotifications"
28719 "url": "/api/userProfile/resources",
28720 "title": "Creates a new User Profile Resource",
28723 "title": "Example usage:",
28724 "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28728 "name": "CreateUser_Profile_Resources",
28729 "group": "User_Profile_Resources",
28744 "field": "resourceId",
28757 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28758 "version": "0.0.0",
28759 "filename": "server/api/userProfileResource/index.js",
28760 "groupTitle": "User_Profile_Resources"
28764 "url": "/api/userProfile/resources/{id}",
28765 "title": "Deletes a User Profile Resource",
28768 "title": "Example usage:",
28769 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
28773 "name": "DeleteUser_Profile_Resources",
28774 "group": "User_Profile_Resources",
28775 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28776 "version": "0.0.0",
28777 "filename": "server/api/userProfileResource/index.js",
28778 "groupTitle": "User_Profile_Resources"
28782 "url": "/api/userProfile/resources/describe",
28783 "title": "Gets table info about User Profile Resources",
28786 "title": "Example usage:",
28787 "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
28791 "name": "DescribeUser_Profile_Resources",
28792 "group": "User_Profile_Resources",
28793 "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>",
28794 "version": "0.0.0",
28795 "filename": "server/api/userProfileResource/index.js",
28796 "groupTitle": "User_Profile_Resources"
28800 "url": "/api/userProfile/resources",
28801 "title": "Gets a list of User Profile Resources",
28804 "title": "Example usage:",
28805 "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
28809 "name": "GetUser_Profile_Resources",
28810 "group": "User_Profile_Resources",
28811 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28812 "version": "0.0.0",
28813 "filename": "server/api/userProfileResource/index.js",
28814 "groupTitle": "User_Profile_Resources"
28818 "url": "/api/userProfile/resources/{id}",
28819 "title": "Gets a single User Profile Resource",
28822 "title": "Example usage:",
28823 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
28827 "name": "ShowUser_Profile_Resources",
28828 "group": "User_Profile_Resources",
28829 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28830 "version": "0.0.0",
28831 "filename": "server/api/userProfileResource/index.js",
28832 "groupTitle": "User_Profile_Resources"
28836 "url": "/api/userProfile/resources/{id}",
28837 "title": "Update an existing User Profile Resource",
28840 "title": "Example usage:",
28841 "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",
28845 "name": "updateUser_Profile_Resources",
28846 "group": "User_Profile_Resources",
28847 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28848 "version": "0.0.0",
28849 "filename": "server/api/userProfileResource/index.js",
28850 "groupTitle": "User_Profile_Resources"
28854 "url": "/api/userProfile/sections",
28855 "title": "Creates a new User Profile Section",
28858 "title": "Example usage:",
28859 "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28863 "name": "CreateUser_Profile_Sections",
28864 "group": "User_Profile_Sections",
28879 "field": "category",
28886 "field": "sectionId",
28893 "field": "enabled",
28900 "field": "autoAssociation",
28907 "field": "crudPermissions",
28913 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28914 "version": "0.0.0",
28915 "filename": "server/api/userProfileSection/index.js",
28916 "groupTitle": "User_Profile_Sections"
28920 "url": "/api/userProfile/sections/{id}",
28921 "title": "Deletes a User Profile Section",
28924 "title": "Example usage:",
28925 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28929 "name": "DeleteUser_Profile_Sections",
28930 "group": "User_Profile_Sections",
28931 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28932 "version": "0.0.0",
28933 "filename": "server/api/userProfileSection/index.js",
28934 "groupTitle": "User_Profile_Sections"
28938 "url": "/api/userProfile/sections/describe",
28939 "title": "Gets table info about User Profile Sections",
28942 "title": "Example usage:",
28943 "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28947 "name": "DescribeUser_Profile_Sections",
28948 "group": "User_Profile_Sections",
28949 "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>",
28950 "version": "0.0.0",
28951 "filename": "server/api/userProfileSection/index.js",
28952 "groupTitle": "User_Profile_Sections"
28956 "url": "/api/userProfile/sections",
28957 "title": "Gets a list of User Profile Sections",
28960 "title": "Example usage:",
28961 "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28965 "name": "GetUser_Profile_Sections",
28966 "group": "User_Profile_Sections",
28967 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28968 "version": "0.0.0",
28969 "filename": "server/api/userProfileSection/index.js",
28970 "groupTitle": "User_Profile_Sections"
28974 "url": "/api/userProfile/sections/{id}",
28975 "title": "Gets a single User Profile Section",
28978 "title": "Example usage:",
28979 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28983 "name": "ShowUser_Profile_Sections",
28984 "group": "User_Profile_Sections",
28985 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28986 "version": "0.0.0",
28987 "filename": "server/api/userProfileSection/index.js",
28988 "groupTitle": "User_Profile_Sections"
28992 "url": "/api/userProfile/sections/{id}",
28993 "title": "Update an existing User Profile Section",
28996 "title": "Example usage:",
28997 "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",
29001 "name": "updateUser_Profile_Sections",
29002 "group": "User_Profile_Sections",
29003 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29004 "version": "0.0.0",
29005 "filename": "server/api/userProfileSection/index.js",
29006 "groupTitle": "User_Profile_Sections"
29010 "url": "/api/userProfiles/{id}/resources",
29011 "title": "Add resources' permissions to User Profile",
29014 "title": "Example usage:",
29015 "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29019 "name": "AddResources",
29020 "group": "User_Profiles",
29021 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29022 "version": "0.0.0",
29023 "filename": "server/api/userProfile/index.js",
29024 "groupTitle": "User_Profiles"
29028 "url": "/api/userProfiles/{id}/sections",
29029 "title": "Add sections' permissions to User Profile",
29032 "title": "Example usage:",
29033 "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29037 "name": "AddSections",
29038 "group": "User_Profiles",
29039 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29040 "version": "0.0.0",
29041 "filename": "server/api/userProfile/index.js",
29042 "groupTitle": "User_Profiles"
29046 "url": "/api/userProfiles/clone",
29047 "title": "Clone an existing User Profile",
29050 "title": "Example usage:",
29051 "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29055 "name": "CloneUser_Profiles",
29056 "group": "User_Profiles",
29057 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29058 "version": "0.0.0",
29059 "filename": "server/api/userProfile/index.js",
29060 "groupTitle": "User_Profiles"
29064 "url": "/api/userProfiles",
29065 "title": "Creates a new User Profile",
29068 "title": "Example usage:",
29069 "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29073 "name": "CreateUser_Profiles",
29074 "group": "User_Profiles",
29089 "field": "crudPermissions",
29096 "field": "description",
29103 "field": "privacyEnabled",
29110 "field": "downloadAttachments",
29117 "field": "downloadCallySquareRecordings",
29124 "field": "downloadContactManagerLists",
29131 "field": "downloadJscriptySessions",
29138 "field": "downloadOmnichannelInteractions",
29145 "field": "downloadScreenRecordings",
29152 "field": "downloadVoiceRecordings",
29158 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29159 "version": "0.0.0",
29160 "filename": "server/api/userProfile/index.js",
29161 "groupTitle": "User_Profiles"
29165 "url": "/api/userProfiles/{id}",
29166 "title": "Deletes a User Profile",
29169 "title": "Example usage:",
29170 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
29174 "name": "DeleteUser_Profiles",
29175 "group": "User_Profiles",
29176 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29177 "version": "0.0.0",
29178 "filename": "server/api/userProfile/index.js",
29179 "groupTitle": "User_Profiles"
29183 "url": "/api/userProfiles/describe",
29184 "title": "Gets table info about User Profiles",
29187 "title": "Example usage:",
29188 "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
29192 "name": "DescribeUser_Profiles",
29193 "group": "User_Profiles",
29194 "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>",
29195 "version": "0.0.0",
29196 "filename": "server/api/userProfile/index.js",
29197 "groupTitle": "User_Profiles"
29201 "url": "/api/userProfiles/{id}/resources?section={section}",
29202 "title": "Get Resources assigned to a Section",
29205 "title": "Example usage:",
29206 "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
29210 "name": "GetResources",
29211 "group": "User_Profiles",
29212 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29213 "version": "0.0.0",
29214 "filename": "server/api/userProfile/index.js",
29215 "groupTitle": "User_Profiles"
29219 "url": "/api/userProfiles/{id}/sections",
29220 "title": "Get sections associated to a User Profile",
29223 "title": "Example usage:",
29224 "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
29228 "name": "GetSections",
29229 "group": "User_Profiles",
29230 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29231 "version": "0.0.0",
29232 "filename": "server/api/userProfile/index.js",
29233 "groupTitle": "User_Profiles"
29237 "url": "/api/userProfiles",
29238 "title": "Gets a list of User Profiles",
29241 "title": "Example usage:",
29242 "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
29246 "name": "GetUser_Profiles",
29247 "group": "User_Profiles",
29248 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29249 "version": "0.0.0",
29250 "filename": "server/api/userProfile/index.js",
29251 "groupTitle": "User_Profiles"
29255 "url": "/api/userProfiles/{id}/resources",
29256 "title": "Removes resources' permissions from User Profile",
29259 "title": "Example usage:",
29260 "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29264 "name": "RemoveResources",
29265 "group": "User_Profiles",
29266 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29267 "version": "0.0.0",
29268 "filename": "server/api/userProfile/index.js",
29269 "groupTitle": "User_Profiles"
29273 "url": "/api/userProfiles/{id}/sections",
29274 "title": "Removes sections' permissions from User Profile",
29277 "title": "Example usage:",
29278 "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29282 "name": "RemoveSections",
29283 "group": "User_Profiles",
29284 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29285 "version": "0.0.0",
29286 "filename": "server/api/userProfile/index.js",
29287 "groupTitle": "User_Profiles"
29291 "url": "/api/userProfiles/{id}",
29292 "title": "Gets a single User Profile",
29295 "title": "Example usage:",
29296 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
29300 "name": "ShowUser_Profiles",
29301 "group": "User_Profiles",
29302 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29303 "version": "0.0.0",
29304 "filename": "server/api/userProfile/index.js",
29305 "groupTitle": "User_Profiles"
29309 "url": "/api/userProfiles/{id}",
29310 "title": "Update an existing User Profile",
29313 "title": "Example usage:",
29314 "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29318 "name": "updateUser_Profiles",
29319 "group": "User_Profiles",
29320 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29321 "version": "0.0.0",
29322 "filename": "server/api/userProfile/index.js",
29323 "groupTitle": "User_Profiles"
29327 "url": "/api/user-settings/{id}",
29328 "title": "Update an existing User Setting",
29331 "title": "Example usage:",
29332 "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",
29336 "name": "updateUserSettings",
29337 "group": "User_Settings",
29338 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29339 "version": "0.0.0",
29340 "filename": "server/api/user-setting/index.js",
29341 "groupTitle": "User_Settings"
29345 "url": "/api/users/{id}/chat_interactions",
29346 "title": "Add chat interaction tabs to an agent",
29349 "title": "Example usage:",
29350 "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",
29354 "name": "AddChatInteractions",
29356 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29357 "version": "0.0.0",
29358 "filename": "server/api/user/index.js",
29359 "groupTitle": "Users"
29363 "url": "/api/users/{id}/chat_websites",
29364 "title": "Add a Chat Website to a user",
29367 "title": "Example usage:",
29368 "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",
29372 "name": "AddChatWebsites",
29374 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29375 "version": "0.0.0",
29376 "filename": "server/api/user/index.js",
29377 "groupTitle": "Users"
29381 "url": "/api/users/{id}/contacts",
29382 "title": "Add contacts to a user",
29385 "title": "Example usage:",
29386 "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29390 "name": "AddContacts",
29392 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29393 "version": "0.0.0",
29394 "filename": "server/api/user/index.js",
29395 "groupTitle": "Users"
29399 "url": "/api/users/{id}/fax_accounts",
29400 "title": "Add a Fax Account to a user",
29403 "title": "Example usage:",
29404 "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",
29408 "name": "AddFaxAccounts",
29410 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29411 "version": "0.0.0",
29412 "filename": "server/api/user/index.js",
29413 "groupTitle": "Users"
29417 "url": "/api/users/{id}/fax_interactions",
29418 "title": "Add fax interaction tabs to an agent",
29421 "title": "Example usage:",
29422 "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",
29426 "name": "AddFaxInteractions",
29428 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29429 "version": "0.0.0",
29430 "filename": "server/api/user/index.js",
29431 "groupTitle": "Users"
29435 "url": "/api/users/{id}/mail_accounts",
29436 "title": "Add a Mail Account to a user",
29439 "title": "Example usage:",
29440 "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",
29444 "name": "AddMailAccounts",
29446 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29447 "version": "0.0.0",
29448 "filename": "server/api/user/index.js",
29449 "groupTitle": "Users"
29453 "url": "/api/users/{id}/mail_interactions",
29454 "title": "Add mail interaction tabs to an agent",
29457 "title": "Example usage:",
29458 "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",
29462 "name": "AddMailInteractions",
29464 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29465 "version": "0.0.0",
29466 "filename": "server/api/user/index.js",
29467 "groupTitle": "Users"
29471 "url": "/api/users/{id}/openchannel_accounts",
29472 "title": "Add a Open Channel Account to a user",
29475 "title": "Example usage:",
29476 "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",
29480 "name": "AddOpenchannelAccounts",
29482 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29483 "version": "0.0.0",
29484 "filename": "server/api/user/index.js",
29485 "groupTitle": "Users"
29489 "url": "/api/users/{id}/openchannel_interactions",
29490 "title": "Add openchannel interaction tabs to an agent",
29493 "title": "Example usage:",
29494 "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",
29498 "name": "AddOpenchannelInteractions",
29500 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29501 "version": "0.0.0",
29502 "filename": "server/api/user/index.js",
29503 "groupTitle": "Users"
29507 "url": "/api/users/{id}/queues",
29508 "title": "Add queues to an agent",
29511 "title": "Example usage:",
29512 "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",
29516 "name": "AddQueues",
29518 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29519 "version": "0.0.0",
29520 "filename": "server/api/user/index.js",
29521 "groupTitle": "Users"
29525 "url": "/api/users/{id}/sms_accounts",
29526 "title": "Add a Sms Account to a user",
29529 "title": "Example usage:",
29530 "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",
29534 "name": "AddSmsAccounts",
29536 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29537 "version": "0.0.0",
29538 "filename": "server/api/user/index.js",
29539 "groupTitle": "Users"
29543 "url": "/api/users/{id}/sms_interactions",
29544 "title": "Add sms interaction tabs to an agent",
29547 "title": "Example usage:",
29548 "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",
29552 "name": "AddSmsInteractions",
29554 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29555 "version": "0.0.0",
29556 "filename": "server/api/user/index.js",
29557 "groupTitle": "Users"
29561 "url": "/api/users/{id}/teams",
29562 "title": "Add teams to an agent",
29565 "title": "Example usage:",
29566 "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29570 "name": "AddTeams",
29572 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29573 "version": "0.0.0",
29574 "filename": "server/api/user/index.js",
29575 "groupTitle": "Users"
29579 "url": "/api/users/{id}/whatsapp_accounts",
29580 "title": "Add a Whatsapp Account to a user",
29583 "title": "Example usage:",
29584 "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",
29588 "name": "AddWhatsappAccounts",
29590 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29591 "version": "0.0.0",
29592 "filename": "server/api/user/index.js",
29593 "groupTitle": "Users"
29597 "url": "/api/users/{id}/whatsapp_interactions",
29598 "title": "Add Whatsapp interaction tabs to an agent",
29601 "title": "Example usage:",
29602 "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",
29606 "name": "AddWhatsappInteractions",
29608 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29609 "version": "0.0.0",
29610 "filename": "server/api/user/index.js",
29611 "groupTitle": "Users"
29615 "url": "/api/users/{id}/password",
29616 "title": "Change user password",
29619 "title": "Example usage:",
29620 "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",
29624 "name": "ChangePwd",
29626 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29627 "version": "0.0.0",
29628 "filename": "server/api/user/index.js",
29629 "groupTitle": "Users"
29633 "url": "/api/users",
29634 "title": "Create a new user",
29637 "title": "Example usage:",
29638 "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29644 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29645 "version": "0.0.0",
29646 "filename": "server/api/user/index.js",
29647 "groupTitle": "Users"
29651 "url": "/api/users/{id}/api_key",
29652 "title": "Create a new API access key for the user",
29655 "title": "Example usage:",
29656 "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29660 "name": "CreateApiKey",
29662 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29663 "version": "0.0.0",
29664 "filename": "server/api/user/index.js",
29665 "groupTitle": "Users"
29669 "url": "/api/users/{id}",
29670 "title": "Deletes a user",
29673 "title": "Example usage:",
29674 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
29680 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29681 "version": "0.0.0",
29682 "filename": "server/api/user/index.js",
29683 "groupTitle": "Users"
29687 "url": "/api/users/describe",
29688 "title": "Gets table info about Users",
29691 "title": "Example usage:",
29692 "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
29696 "name": "DescribeUsers",
29698 "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>",
29699 "version": "0.0.0",
29700 "filename": "server/api/user/index.js",
29701 "groupTitle": "Users"
29705 "url": "/api/users/{id}/agents",
29706 "title": "GetAgents",
29709 "title": "Example usage:",
29710 "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
29714 "name": "GetAgents",
29716 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29717 "version": "0.0.0",
29718 "filename": "server/api/user/index.js",
29719 "groupTitle": "Users"
29723 "url": "/api/users/{id}/api_key",
29724 "title": "Get the API access key for the user",
29727 "title": "Example usage:",
29728 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
29732 "name": "GetApiKey",
29734 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29735 "version": "0.0.0",
29736 "filename": "server/api/user/index.js",
29737 "groupTitle": "Users"
29741 "url": "/api/users/{id}/groups",
29742 "title": "GetChatGroups",
29745 "title": "Example usage:",
29746 "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
29750 "name": "GetChatGroups",
29752 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29753 "version": "0.0.0",
29754 "filename": "server/api/user/index.js",
29755 "groupTitle": "Users"
29759 "url": "/api/users/{id}/chat/interactions",
29760 "title": "GetChatInteractions",
29763 "title": "Example usage:",
29764 "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
29768 "name": "GetChatInteractions",
29770 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29771 "version": "0.0.0",
29772 "filename": "server/api/user/index.js",
29773 "groupTitle": "Users"
29777 "url": "/api/users/{id}/chat_websites",
29778 "title": "GetChatWebsites",
29781 "title": "Example usage:",
29782 "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
29786 "name": "GetChatWebsites",
29788 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29789 "version": "0.0.0",
29790 "filename": "server/api/user/index.js",
29791 "groupTitle": "Users"
29795 "url": "/api/users/{id}/contacts",
29796 "title": "GetContacts",
29799 "title": "Example usage:",
29800 "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
29804 "name": "GetContacts",
29806 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29807 "version": "0.0.0",
29808 "filename": "server/api/user/index.js",
29809 "groupTitle": "Users"
29813 "url": "/api/users/{id}/fax_accounts",
29814 "title": "GetFaxAccounts",
29817 "title": "Example usage:",
29818 "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
29822 "name": "GetFaxAccounts",
29824 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29825 "version": "0.0.0",
29826 "filename": "server/api/user/index.js",
29827 "groupTitle": "Users"
29831 "url": "/api/users/{id}/fax/interactions",
29832 "title": "GetFaxInteractions",
29835 "title": "Example usage:",
29836 "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
29840 "name": "GetFaxInteractions",
29842 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29843 "version": "0.0.0",
29844 "filename": "server/api/user/index.js",
29845 "groupTitle": "Users"
29849 "url": "/api/users/{id}/lists",
29850 "title": "GetLists",
29853 "title": "Example usage:",
29854 "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
29858 "name": "GetLists",
29860 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29861 "version": "0.0.0",
29862 "filename": "server/api/user/index.js",
29863 "groupTitle": "Users"
29867 "url": "/api/users/{id}/mail_accounts",
29868 "title": "GetMailAccounts",
29871 "title": "Example usage:",
29872 "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29876 "name": "GetMailAccounts",
29878 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29879 "version": "0.0.0",
29880 "filename": "server/api/user/index.js",
29881 "groupTitle": "Users"
29885 "url": "/api/users/{id}/mail/interactions",
29886 "title": "GetMailInteractions",
29889 "title": "Example usage:",
29890 "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29894 "name": "GetMailInteractions",
29896 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29897 "version": "0.0.0",
29898 "filename": "server/api/user/index.js",
29899 "groupTitle": "Users"
29903 "url": "/api/users/{id}/openchannel_accounts",
29904 "title": "GetOpenchannelAccounts",
29907 "title": "Example usage:",
29908 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29912 "name": "GetOpenchannelAccounts",
29914 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29915 "version": "0.0.0",
29916 "filename": "server/api/user/index.js",
29917 "groupTitle": "Users"
29921 "url": "/api/users/{id}/openchannel/interactions",
29922 "title": "GetOpenchannelInteractions",
29925 "title": "Example usage:",
29926 "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29930 "name": "GetOpenchannelInteractions",
29932 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29933 "version": "0.0.0",
29934 "filename": "server/api/user/index.js",
29935 "groupTitle": "Users"
29939 "url": "/api/users/{id}/prefixes",
29940 "title": "GetPrefixes",
29943 "title": "Example usage:",
29944 "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29948 "name": "GetPrefixes",
29950 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29951 "version": "0.0.0",
29952 "filename": "server/api/user/index.js",
29953 "groupTitle": "Users"
29957 "url": "/api/users/{id}/queues?channel={channel}",
29958 "title": "Gets Queues list",
29961 "title": "Example usage:",
29962 "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29966 "name": "GetQueues",
29968 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29969 "version": "0.0.0",
29970 "filename": "server/api/user/index.js",
29971 "groupTitle": "Users"
29975 "url": "/api/users/{id}/recordings",
29976 "title": "GetRecordings",
29979 "title": "Example usage:",
29980 "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29984 "name": "GetRecordings",
29986 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29987 "version": "0.0.0",
29988 "filename": "server/api/user/index.js",
29989 "groupTitle": "Users"
29993 "url": "/api/users/{id}/scheduled_calls",
29994 "title": "GetScheduledCalls",
29997 "title": "Example usage:",
29998 "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
30002 "name": "GetScheduledCalls",
30004 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30005 "version": "0.0.0",
30006 "filename": "server/api/user/index.js",
30007 "groupTitle": "Users"
30011 "url": "/api/users/{id}/screen_recordings",
30012 "title": "GetScreenRecordings",
30015 "title": "Example usage:",
30016 "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
30020 "name": "GetScreenRecordings",
30022 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30023 "version": "0.0.0",
30024 "filename": "server/api/user/index.js",
30025 "groupTitle": "Users"
30029 "url": "/api/users/{id}/sms_accounts",
30030 "title": "GetSmsAccounts",
30033 "title": "Example usage:",
30034 "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
30038 "name": "GetSmsAccounts",
30040 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30041 "version": "0.0.0",
30042 "filename": "server/api/user/index.js",
30043 "groupTitle": "Users"
30047 "url": "/api/users/{id}/sms/interactions",
30048 "title": "GetSmsInteractions",
30051 "title": "Example usage:",
30052 "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
30056 "name": "GetSmsInteractions",
30058 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30059 "version": "0.0.0",
30060 "filename": "server/api/user/index.js",
30061 "groupTitle": "Users"
30065 "url": "/api/users/{id}/teams",
30066 "title": "GetTeams",
30069 "title": "Example usage:",
30070 "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
30074 "name": "GetTeams",
30076 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30077 "version": "0.0.0",
30078 "filename": "server/api/user/index.js",
30079 "groupTitle": "Users"
30083 "url": "/api/users",
30084 "title": "Gets a list of Users",
30087 "title": "Example usage:",
30088 "content": "curl https://{domain}/api/users -v -u {name}:{password}",
30092 "name": "GetUsers",
30094 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30095 "version": "0.0.0",
30096 "filename": "server/api/user/index.js",
30097 "groupTitle": "Users"
30101 "url": "/api/users/{id}/queues_rt",
30102 "title": "GetVoiceQueuesRt",
30105 "title": "Example usage:",
30106 "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
30110 "name": "GetVoiceQueuesRt",
30112 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30113 "version": "0.0.0",
30114 "filename": "server/api/user/index.js",
30115 "groupTitle": "Users"
30119 "url": "/api/users/{id}/whatsapp_accounts",
30120 "title": "GetWhatsappAccounts",
30123 "title": "Example usage:",
30124 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
30128 "name": "GetWhatsappAccounts",
30130 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30131 "version": "0.0.0",
30132 "filename": "server/api/user/index.js",
30133 "groupTitle": "Users"
30137 "url": "/api/users/{id}/whatsapp/interactions",
30138 "title": "GetWhatsappInteractions",
30141 "title": "Example usage:",
30142 "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
30146 "name": "GetWhatsappInteractions",
30148 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30149 "version": "0.0.0",
30150 "filename": "server/api/user/index.js",
30151 "groupTitle": "Users"
30155 "url": "/api/users/{id}/login",
30159 "title": "Example usage:",
30160 "content": "curl https://{domain}/api/users/{id}/login -v -u {name}:{password} -X POST",
30166 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30167 "version": "0.0.0",
30168 "filename": "server/api/user/index.js",
30169 "groupTitle": "Users"
30173 "url": "/api/users/{id}/logout",
30177 "title": "Example usage:",
30178 "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
30184 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30185 "version": "0.0.0",
30186 "filename": "server/api/user/index.js",
30187 "groupTitle": "Users"
30191 "url": "/api/users/{id}/pause",
30195 "title": "Example usage:",
30196 "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
30202 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30203 "version": "0.0.0",
30204 "filename": "server/api/user/index.js",
30205 "groupTitle": "Users"
30209 "url": "/api/users/{id}/api_key",
30210 "title": "Remove API access key for the user",
30213 "title": "Example usage:",
30214 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
30218 "name": "RemoveApiKey",
30220 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30221 "version": "0.0.0",
30222 "filename": "server/api/user/index.js",
30223 "groupTitle": "Users"
30227 "url": "/api/users/{id}/chat_interactions",
30228 "title": "Removes interactions from an agent",
30231 "title": "Example usage:",
30232 "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30236 "name": "RemoveChatInteractions",
30238 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30239 "version": "0.0.0",
30240 "filename": "server/api/user/index.js",
30241 "groupTitle": "Users"
30245 "url": "/api/users/{id}/chat_websites",
30246 "title": "Removes a Chat Website from a user",
30249 "title": "Example usage:",
30250 "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30254 "name": "RemoveChatWebsites",
30256 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30257 "version": "0.0.0",
30258 "filename": "server/api/user/index.js",
30259 "groupTitle": "Users"
30263 "url": "/api/users/{id}/fax_accounts",
30264 "title": "Removes a Fax Account from a user",
30267 "title": "Example usage:",
30268 "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30272 "name": "RemoveFaxAccounts",
30274 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30275 "version": "0.0.0",
30276 "filename": "server/api/user/index.js",
30277 "groupTitle": "Users"
30281 "url": "/api/users/{id}/fax_interactions",
30282 "title": "Removes interactions from an agent",
30285 "title": "Example usage:",
30286 "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30290 "name": "RemoveFaxInteractions",
30292 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30293 "version": "0.0.0",
30294 "filename": "server/api/user/index.js",
30295 "groupTitle": "Users"
30299 "url": "/api/users/{id}/mail_accounts",
30300 "title": "Removes a Mail Account from a user",
30303 "title": "Example usage:",
30304 "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30308 "name": "RemoveMailAccounts",
30310 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30311 "version": "0.0.0",
30312 "filename": "server/api/user/index.js",
30313 "groupTitle": "Users"
30317 "url": "/api/users/{id}/mail_interactions",
30318 "title": "Removes interactions from an agent",
30321 "title": "Example usage:",
30322 "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30326 "name": "RemoveMailInteractions",
30328 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30329 "version": "0.0.0",
30330 "filename": "server/api/user/index.js",
30331 "groupTitle": "Users"
30335 "url": "/api/users/{id}/openchannel_accounts",
30336 "title": "Removes a Open Channel Account from a user",
30339 "title": "Example usage:",
30340 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30344 "name": "RemoveOpenchannelAccounts",
30346 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30347 "version": "0.0.0",
30348 "filename": "server/api/user/index.js",
30349 "groupTitle": "Users"
30353 "url": "/api/users/{id}/openchannel_interactions",
30354 "title": "Removes openchannel interactions from an agent",
30357 "title": "Example usage:",
30358 "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30362 "name": "RemoveOpenchannelInteractions",
30364 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30365 "version": "0.0.0",
30366 "filename": "server/api/user/index.js",
30367 "groupTitle": "Users"
30371 "url": "/api/users/{id}/queues",
30372 "title": "Remove queues to an agent",
30375 "title": "Example usage:",
30376 "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30380 "name": "RemoveQueues",
30382 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30383 "version": "0.0.0",
30384 "filename": "server/api/user/index.js",
30385 "groupTitle": "Users"
30389 "url": "/api/users/{id}/sms_accounts",
30390 "title": "Removes a Sms Account from a user",
30393 "title": "Example usage:",
30394 "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30398 "name": "RemoveSmsAccounts",
30400 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30401 "version": "0.0.0",
30402 "filename": "server/api/user/index.js",
30403 "groupTitle": "Users"
30407 "url": "/api/users/{id}/sms_interactions",
30408 "title": "Removes interactions from an agent",
30411 "title": "Example usage:",
30412 "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30416 "name": "RemoveSmsInteractions",
30418 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30419 "version": "0.0.0",
30420 "filename": "server/api/user/index.js",
30421 "groupTitle": "Users"
30425 "url": "/api/users/{id}/teams",
30426 "title": "Removes teams from an agent",
30429 "title": "Example usage:",
30430 "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30434 "name": "RemoveTeams",
30436 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30437 "version": "0.0.0",
30438 "filename": "server/api/user/index.js",
30439 "groupTitle": "Users"
30443 "url": "/api/users/{id}/whatsapp_accounts",
30444 "title": "Removes a Whatsapp Account from a user",
30447 "title": "Example usage:",
30448 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30452 "name": "RemoveWhatsappAccounts",
30454 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30455 "version": "0.0.0",
30456 "filename": "server/api/user/index.js",
30457 "groupTitle": "Users"
30461 "url": "/api/users/{id}/whatsapp_interactions",
30462 "title": "Removes Whatsapp interactions from an agent",
30465 "title": "Example usage:",
30466 "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30470 "name": "RemoveWhatsappInteractions",
30472 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30473 "version": "0.0.0",
30474 "filename": "server/api/user/index.js",
30475 "groupTitle": "Users"
30479 "url": "/api/users/{id}",
30480 "title": "Gets a single User",
30483 "title": "Example usage:",
30484 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
30488 "name": "ShowUsers",
30490 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30491 "version": "0.0.0",
30492 "filename": "server/api/user/index.js",
30493 "groupTitle": "Users"
30497 "url": "/api/users/{id}/unpause",
30498 "title": "Unpause",
30501 "title": "Example usage:",
30502 "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
30508 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30509 "version": "0.0.0",
30510 "filename": "server/api/user/index.js",
30511 "groupTitle": "Users"
30515 "url": "/api/users/whoami",
30519 "title": "Example usage:",
30520 "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
30526 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30527 "version": "0.0.0",
30528 "filename": "server/api/user/index.js",
30529 "groupTitle": "Users"
30533 "url": "/api/users/{id}/avatar",
30534 "title": "Add avatar",
30537 "title": "Example usage:",
30538 "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
30542 "name": "addAvatar",
30544 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30545 "version": "0.0.0",
30546 "filename": "server/api/user/index.js",
30547 "groupTitle": "Users"
30551 "url": "/api/users/create_many",
30552 "title": "Create Users",
30555 "title": "Example usage:",
30556 "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
30560 "name": "bulkCreate",
30562 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30563 "version": "0.0.0",
30564 "filename": "server/api/user/index.js",
30565 "groupTitle": "Users"
30569 "url": "/api/users/{id}/avatar",
30570 "title": "Get avatar",
30573 "title": "Example usage:",
30574 "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
30578 "name": "getAvatar",
30580 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30581 "version": "0.0.0",
30582 "filename": "server/api/user/index.js",
30583 "groupTitle": "Users"
30587 "url": "/api/users/{id}/open_tabs",
30588 "title": "Get interactions opened tabs",
30591 "title": "Example usage:",
30592 "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
30596 "name": "getOpenTabs",
30598 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30599 "version": "0.0.0",
30600 "filename": "server/api/user/index.js",
30601 "groupTitle": "Users"
30605 "url": "/api/users/presence",
30606 "title": "Gets agent presence",
30609 "title": "Example usage:",
30610 "content": "curl https://{domain}/api/users/presence -v -u {name}:{password} -X GET",
30614 "name": "getPresence",
30616 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30617 "version": "0.0.0",
30618 "filename": "server/api/user/index.js",
30619 "groupTitle": "Users"
30623 "url": "/api/users/{id}/messengerSoundNotification",
30624 "title": "MessengerSoundNotification",
30627 "title": "Example usage:",
30628 "content": "curl https://{domain}/api/users/{id}/messengerSoundNotification -v -u {name}:{password} -X POST",
30632 "name": "messengerSoundNotification",
30634 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30635 "version": "0.0.0",
30636 "filename": "server/api/user/index.js",
30637 "groupTitle": "Users"
30641 "url": "/api/users/{id}",
30642 "title": "Update an existing User",
30645 "title": "Example usage:",
30646 "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30650 "name": "updateUsers",
30652 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30653 "version": "0.0.0",
30654 "filename": "server/api/user/index.js",
30655 "groupTitle": "Users"
30659 "url": "/api/variables",
30660 "title": "Creates a new Variable",
30663 "title": "Example usage:",
30664 "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30668 "name": "CreateVariables",
30669 "group": "Variables",
30684 "field": "description",
30690 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30691 "version": "0.0.0",
30692 "filename": "server/api/variable/index.js",
30693 "groupTitle": "Variables"
30697 "url": "/api/variables/{id}",
30698 "title": "Deletes a Variable",
30701 "title": "Example usage:",
30702 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
30706 "name": "DeleteVariables",
30707 "group": "Variables",
30708 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30709 "version": "0.0.0",
30710 "filename": "server/api/variable/index.js",
30711 "groupTitle": "Variables"
30715 "url": "/api/variables",
30716 "title": "Gets a list of Variables",
30719 "title": "Example usage:",
30720 "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
30724 "name": "GetVariables",
30725 "group": "Variables",
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/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>",
30727 "version": "0.0.0",
30728 "filename": "server/api/variable/index.js",
30729 "groupTitle": "Variables"
30733 "url": "/api/variables/{id}",
30734 "title": "Gets a single Variable",
30737 "title": "Example usage:",
30738 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
30742 "name": "ShowVariables",
30743 "group": "Variables",
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/variable/index.js",
30747 "groupTitle": "Variables"
30751 "url": "/api/variables/{id}",
30752 "title": "Update an existing Variable",
30755 "title": "Example usage:",
30756 "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30760 "name": "updateVariables",
30761 "group": "Variables",
30762 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/variable/index.js",
30765 "groupTitle": "Variables"
30769 "url": "/api/version/fetch",
30770 "title": "Fetch git version",
30773 "title": "Example usage:",
30774 "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
30778 "name": "FetchVersion",
30779 "group": "Version",
30780 "description": "<p>Motion run the following command: git fetch origin master</p>",
30781 "version": "0.0.0",
30782 "filename": "server/api/version/index.js",
30783 "groupTitle": "Version"
30787 "url": "/api/version",
30788 "title": "Gets version",
30791 "title": "Example usage:",
30792 "content": "curl https://{domain}/api/version -v -u {name}:{password}",
30796 "name": "GetVersion",
30797 "group": "Version",
30798 "description": "<p>Motion returns the current and latest motion version.</p>",
30799 "version": "0.0.0",
30800 "filename": "server/api/version/index.js",
30801 "groupTitle": "Version"
30805 "url": "/api/version/migrations",
30806 "title": "Launch database migrations",
30809 "title": "Example usage:",
30810 "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
30814 "name": "MigrateVersion",
30815 "group": "Version",
30816 "description": "<p>Motion launch the database migrations, according to the application version</p>",
30817 "version": "0.0.0",
30818 "filename": "server/api/version/index.js",
30819 "groupTitle": "Version"
30823 "url": "/api/version/pull",
30824 "title": "Pull git version",
30827 "title": "Example usage:",
30828 "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
30832 "name": "PullVersion",
30833 "group": "Version",
30834 "description": "<p>Motion run the following command: git pull</p>",
30835 "version": "0.0.0",
30836 "filename": "server/api/version/index.js",
30837 "groupTitle": "Version"
30841 "url": "/api/version/reset",
30842 "title": "Reset git version",
30845 "title": "Example usage:",
30846 "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30850 "name": "ResetVersion",
30851 "group": "Version",
30852 "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
30853 "version": "0.0.0",
30854 "filename": "server/api/version/index.js",
30855 "groupTitle": "Version"
30859 "url": "/api/version/restart",
30860 "title": "Restart motion2 after update",
30863 "title": "Example usage:",
30864 "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30868 "name": "RestartVersion",
30869 "group": "Version",
30870 "description": "<p>Motion run the following command: pm2 restart motion</p>",
30871 "version": "0.0.0",
30872 "filename": "server/api/version/index.js",
30873 "groupTitle": "Version"
30877 "url": "/api/voice/agents/reports/describe",
30878 "title": "Gets table info about Agent Reports",
30881 "title": "Example usage:",
30882 "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30886 "name": "DescribeAgent_Reports",
30887 "group": "Voice_Agent_Reports",
30888 "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>",
30889 "version": "0.0.0",
30890 "filename": "server/api/voiceAgentReport/index.js",
30891 "groupTitle": "Voice_Agent_Reports"
30895 "url": "/api/voice/agents/reports",
30896 "title": "Gets a list of Agent Reports",
30899 "title": "Example usage:",
30900 "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30904 "name": "GetAgent_Reports",
30905 "group": "Voice_Agent_Reports",
30906 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30907 "version": "0.0.0",
30908 "filename": "server/api/voiceAgentReport/index.js",
30909 "groupTitle": "Voice_Agent_Reports"
30913 "url": "/api/voice/agents/reports/{id}",
30914 "title": "Gets a single Agent Report",
30917 "title": "Example usage:",
30918 "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30922 "name": "ShowAgent_Reports",
30923 "group": "Voice_Agent_Reports",
30924 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30925 "version": "0.0.0",
30926 "filename": "server/api/voiceAgentReport/index.js",
30927 "groupTitle": "Voice_Agent_Reports"
30931 "url": "/api/voice/calls/reports/describe",
30932 "title": "Gets table info about Call Reports",
30935 "title": "Example usage:",
30936 "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30940 "name": "DescribeCall_Reports",
30941 "group": "Voice_Call_Reports",
30942 "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>",
30943 "version": "0.0.0",
30944 "filename": "server/api/voiceCallReport/index.js",
30945 "groupTitle": "Voice_Call_Reports"
30949 "url": "/api/voice/calls/reports",
30950 "title": "Gets a list of Call Reports",
30953 "title": "Example usage:",
30954 "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30958 "name": "GetCall_Reports",
30959 "group": "Voice_Call_Reports",
30960 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30961 "version": "0.0.0",
30962 "filename": "server/api/voiceCallReport/index.js",
30963 "groupTitle": "Voice_Call_Reports"
30967 "url": "/api/voice/calls/reports/{id}",
30968 "title": "Gets a single Call Report",
30971 "title": "Example usage:",
30972 "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30976 "name": "ShowCall_Reports",
30977 "group": "Voice_Call_Reports",
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/voiceCallReport/index.js",
30981 "groupTitle": "Voice_Call_Reports"
30985 "url": "/api/voice/calls/reports/{id}",
30986 "title": "Update a single cdr",
30989 "title": "Example usage:",
30990 "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30995 "group": "Voice_Call_Reports",
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/voiceCallReport/index.js",
30999 "groupTitle": "Voice_Call_Reports"
31003 "url": "/api/voice/calls/reports/{id}",
31004 "title": "Update a single cdr",
31007 "title": "Example usage:",
31008 "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDisposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
31013 "group": "Voice_Call_Reports",
31014 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31015 "version": "0.0.0",
31016 "filename": "server/api/voiceCallReport/index.js",
31017 "groupTitle": "Voice_Call_Reports"
31021 "url": "/api/voice/chanspy",
31022 "title": "Creates a new ChanSpy",
31025 "title": "Example usage:",
31026 "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31030 "name": "CreateChanSpy",
31031 "group": "Voice_ChanSpy",
31053 "field": "options",
31067 "field": "password",
31081 "field": "recordingFormat",
31088 "field": "description",
31094 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31095 "version": "0.0.0",
31096 "filename": "server/api/voiceChanSpy/index.js",
31097 "groupTitle": "Voice_ChanSpy"
31101 "url": "/api/voice/chanspy/{id}",
31102 "title": "Deletes a ChanSpy",
31105 "title": "Example usage:",
31106 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
31110 "name": "DeleteChanSpy",
31111 "group": "Voice_ChanSpy",
31112 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31113 "version": "0.0.0",
31114 "filename": "server/api/voiceChanSpy/index.js",
31115 "groupTitle": "Voice_ChanSpy"
31119 "url": "/api/voice/chanspy",
31120 "title": "Gets a list of ChanSpy",
31123 "title": "Example usage:",
31124 "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
31128 "name": "GetChanSpy",
31129 "group": "Voice_ChanSpy",
31130 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31131 "version": "0.0.0",
31132 "filename": "server/api/voiceChanSpy/index.js",
31133 "groupTitle": "Voice_ChanSpy"
31137 "url": "/api/voice/chanspy/{id}",
31138 "title": "Gets a single ChanSpy",
31141 "title": "Example usage:",
31142 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
31146 "name": "ShowChanSpy",
31147 "group": "Voice_ChanSpy",
31148 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31149 "version": "0.0.0",
31150 "filename": "server/api/voiceChanSpy/index.js",
31151 "groupTitle": "Voice_ChanSpy"
31155 "url": "/api/voice/chanspy/{id}",
31156 "title": "Update an existing ChanSpy",
31159 "title": "Example usage:",
31160 "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",
31164 "name": "updateChanSpy",
31165 "group": "Voice_ChanSpy",
31166 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31167 "version": "0.0.0",
31168 "filename": "server/api/voiceChanSpy/index.js",
31169 "groupTitle": "Voice_ChanSpy"
31173 "url": "/api/voice/contexts",
31174 "title": "Create a new context",
31177 "title": "Example usage:",
31178 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
31183 "group": "Voice_Contexts",
31198 "field": "description",
31205 "field": "defaultEntry",
31211 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31212 "version": "0.0.0",
31213 "filename": "server/api/voiceContext/index.js",
31214 "groupTitle": "Voice_Contexts"
31218 "url": "/api/voice/contexts/{id}",
31219 "title": "Deletes a context",
31222 "title": "Example usage:",
31223 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
31228 "group": "Voice_Contexts",
31229 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31230 "version": "0.0.0",
31231 "filename": "server/api/voiceContext/index.js",
31232 "groupTitle": "Voice_Contexts"
31236 "url": "/api/voice/contexts",
31237 "title": "Gets a list of Contexts",
31240 "title": "Example usage:",
31241 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
31245 "name": "GetContexts",
31246 "group": "Voice_Contexts",
31247 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/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>",
31248 "version": "0.0.0",
31249 "filename": "server/api/voiceContext/index.js",
31250 "groupTitle": "Voice_Contexts"
31254 "url": "/api/voice/contexts/{id}",
31255 "title": "Gets a single Context",
31258 "title": "Example usage:",
31259 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
31263 "name": "ShowContexts",
31264 "group": "Voice_Contexts",
31265 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31266 "version": "0.0.0",
31267 "filename": "server/api/voiceContext/index.js",
31268 "groupTitle": "Voice_Contexts"
31272 "url": "/api/voice/contexts/{id}",
31273 "title": "Update an existing context",
31276 "title": "Example usage:",
31277 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
31282 "group": "Voice_Contexts",
31283 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31284 "version": "0.0.0",
31285 "filename": "server/api/voiceContext/index.js",
31286 "groupTitle": "Voice_Contexts"
31290 "url": "/api/voice/dials/reports/describe",
31291 "title": "Gets table info about Dial Reports",
31294 "title": "Example usage:",
31295 "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
31299 "name": "DescribeDial_Reports",
31300 "group": "Voice_Dial_Reports",
31301 "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>",
31302 "version": "0.0.0",
31303 "filename": "server/api/voiceDialReport/index.js",
31304 "groupTitle": "Voice_Dial_Reports"
31308 "url": "/api/voice/dials/reports",
31309 "title": "Gets a list of Dial Reports",
31312 "title": "Example usage:",
31313 "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
31317 "name": "GetDial_Reports",
31318 "group": "Voice_Dial_Reports",
31319 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31320 "version": "0.0.0",
31321 "filename": "server/api/voiceDialReport/index.js",
31322 "groupTitle": "Voice_Dial_Reports"
31326 "url": "/api/voice/dials/reports/{id}",
31327 "title": "Gets a single Dial Report",
31330 "title": "Example usage:",
31331 "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
31335 "name": "ShowDial_Reports",
31336 "group": "Voice_Dial_Reports",
31337 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31338 "version": "0.0.0",
31339 "filename": "server/api/voiceDialReport/index.js",
31340 "groupTitle": "Voice_Dial_Reports"
31344 "url": "/api/voice/extensions/{id}",
31345 "title": "Deletes a Extension",
31348 "title": "Example usage:",
31349 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
31353 "name": "DeleteExtensions",
31354 "group": "Voice_Extensions",
31355 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31356 "version": "0.0.0",
31357 "filename": "server/api/voiceExtension/index.js",
31358 "groupTitle": "Voice_Extensions"
31362 "url": "/api/voice/extensions",
31363 "title": "Gets a list of Extensions",
31366 "title": "Example usage:",
31367 "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
31371 "name": "GetExtensions",
31372 "group": "Voice_Extensions",
31373 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31374 "version": "0.0.0",
31375 "filename": "server/api/voiceExtension/index.js",
31376 "groupTitle": "Voice_Extensions"
31380 "url": "/api/voice/extensions/{id}",
31381 "title": "Gets a single Extension",
31384 "title": "Example usage:",
31385 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
31389 "name": "ShowExtensions",
31390 "group": "Voice_Extensions",
31391 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31392 "version": "0.0.0",
31393 "filename": "server/api/voiceExtension/index.js",
31394 "groupTitle": "Voice_Extensions"
31398 "url": "/api/voice/extensions",
31399 "title": "Create new applications",
31402 "title": "Example usage:",
31403 "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",
31407 "name": "addApplications",
31408 "group": "Voice_Extensions",
31409 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31410 "version": "0.0.0",
31411 "filename": "server/api/voiceExtension/index.js",
31412 "groupTitle": "Voice_Extensions"
31416 "url": "/api/voice/extensions",
31417 "title": "Create an extension",
31420 "title": "Example usage:",
31421 "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31426 "group": "Voice_Extensions",
31427 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31428 "version": "0.0.0",
31429 "filename": "server/api/voiceExtension/index.js",
31430 "groupTitle": "Voice_Extensions"
31434 "url": "/api/voice/extensions/{id}",
31435 "title": "Update an extension",
31438 "title": "Example usage:",
31439 "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",
31444 "group": "Voice_Extensions",
31445 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31446 "version": "0.0.0",
31447 "filename": "server/api/voiceExtension/index.js",
31448 "groupTitle": "Voice_Extensions"
31452 "url": "/api/voice/mohs",
31453 "title": "Create a new a new MOH",
31456 "title": "Example usage:",
31457 "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31462 "group": "Voice_MOHs",
31463 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31464 "version": "0.0.0",
31465 "filename": "server/api/voiceMusicOnHold/index.js",
31466 "groupTitle": "Voice_MOHs"
31470 "url": "/api/voice/mohs/{id}/sounds",
31471 "title": "Add sound to MOH",
31474 "title": "Example usage:",
31475 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31479 "name": "AddSound",
31480 "group": "Voice_MOHs",
31481 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31482 "version": "0.0.0",
31483 "filename": "server/api/voiceMusicOnHold/index.js",
31484 "groupTitle": "Voice_MOHs"
31488 "url": "/api/voice/mohs/{id}",
31489 "title": "Deletes an MOH",
31492 "title": "Example usage:",
31493 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
31497 "name": "DestroyMoh",
31498 "group": "Voice_MOHs",
31499 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31500 "version": "0.0.0",
31501 "filename": "server/api/voiceMusicOnHold/index.js",
31502 "groupTitle": "Voice_MOHs"
31506 "url": "/api/voice/mohs",
31507 "title": "Gets a list of Music On Holds",
31510 "title": "Example usage:",
31511 "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
31515 "name": "GetMusic_On_Holds",
31516 "group": "Voice_MOHs",
31517 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31518 "version": "0.0.0",
31519 "filename": "server/api/voiceMusicOnHold/index.js",
31520 "groupTitle": "Voice_MOHs"
31524 "url": "/api/voice/mohs/{id}/sounds",
31525 "title": "Gets sounds from MOH",
31528 "title": "Example usage:",
31529 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
31533 "name": "GetSounds",
31534 "group": "Voice_MOHs",
31535 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31536 "version": "0.0.0",
31537 "filename": "server/api/voiceMusicOnHold/index.js",
31538 "groupTitle": "Voice_MOHs"
31542 "url": "/api/voice/mohs/{id}/sounds/{id2}",
31543 "title": "Remove sound from MOH",
31546 "title": "Example usage:",
31547 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
31551 "name": "RemoveSound",
31552 "group": "Voice_MOHs",
31553 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31554 "version": "0.0.0",
31555 "filename": "server/api/voiceMusicOnHold/index.js",
31556 "groupTitle": "Voice_MOHs"
31560 "url": "/api/voice/mohs/{id}",
31561 "title": "Gets a single Music On Hold",
31564 "title": "Example usage:",
31565 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
31569 "name": "ShowMusic_On_Holds",
31570 "group": "Voice_MOHs",
31571 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31572 "version": "0.0.0",
31573 "filename": "server/api/voiceMusicOnHold/index.js",
31574 "groupTitle": "Voice_MOHs"
31578 "url": "/api/voice/mohs/{id}",
31579 "title": "Update an existing Music On Hold",
31582 "title": "Example usage:",
31583 "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",
31587 "name": "updateMusic_On_Holds",
31588 "group": "Voice_MOHs",
31589 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31590 "version": "0.0.0",
31591 "filename": "server/api/voiceMusicOnHold/index.js",
31592 "groupTitle": "Voice_MOHs"
31596 "url": "/api/voice/mails",
31597 "title": "Creates a new Mail",
31600 "title": "Example usage:",
31601 "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31605 "name": "CreateMails",
31606 "group": "Voice_Mails",
31614 "field": "customer_id",
31621 "field": "context",
31628 "field": "mailbox",
31635 "field": "password",
31642 "field": "fullname",
31692 "field": "dialout",
31699 "field": "callback",
31721 "field": "operator",
31732 "field": "envelope",
31743 "field": "sayduration",
31750 "field": "saydurationm",
31761 "field": "sendvoicemail",
31783 "field": "nextaftercmd",
31794 "field": "forcename",
31805 "field": "forcegreetings",
31816 "field": "hidefromdir",
31830 "field": "emailsubject",
31837 "field": "emailbody",
31844 "field": "maxsecs",
31864 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31865 "version": "0.0.0",
31866 "filename": "server/api/voiceMail/index.js",
31867 "groupTitle": "Voice_Mails"
31871 "url": "/api/voice/mails/{id}",
31872 "title": "Deletes a Mail",
31875 "title": "Example usage:",
31876 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31880 "name": "DeleteMails",
31881 "group": "Voice_Mails",
31882 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31883 "version": "0.0.0",
31884 "filename": "server/api/voiceMail/index.js",
31885 "groupTitle": "Voice_Mails"
31889 "url": "/api/voice/mails",
31890 "title": "Gets a list of Mails",
31893 "title": "Example usage:",
31894 "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31898 "name": "GetMails",
31899 "group": "Voice_Mails",
31900 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31901 "version": "0.0.0",
31902 "filename": "server/api/voiceMail/index.js",
31903 "groupTitle": "Voice_Mails"
31907 "url": "/api/voice/mails/{id}",
31908 "title": "Gets a single Mail",
31911 "title": "Example usage:",
31912 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31916 "name": "ShowMails",
31917 "group": "Voice_Mails",
31918 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31919 "version": "0.0.0",
31920 "filename": "server/api/voiceMail/index.js",
31921 "groupTitle": "Voice_Mails"
31925 "url": "/api/voice/mails/{id}/messages",
31926 "title": "Gets voice mail messages",
31929 "title": "Example usage:",
31930 "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31934 "name": "getMessages",
31935 "group": "Voice_Mails",
31936 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31937 "version": "0.0.0",
31938 "filename": "server/api/voiceMail/index.js",
31939 "groupTitle": "Voice_Mails"
31943 "url": "/api/voice/mails/{id}",
31944 "title": "Update an existing Mail",
31947 "title": "Example usage:",
31948 "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",
31952 "name": "updateMails",
31953 "group": "Voice_Mails",
31954 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31955 "version": "0.0.0",
31956 "filename": "server/api/voiceMail/index.js",
31957 "groupTitle": "Voice_Mails"
31961 "url": "/api/voice/mails/messages",
31962 "title": "Creates a new Message",
31965 "title": "Example usage:",
31966 "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",
31970 "name": "CreateMessages",
31971 "group": "Voice_Messages",
32000 "field": "context",
32007 "field": "macrocontext",
32014 "field": "callerid",
32021 "field": "origtime",
32028 "field": "duration",
32035 "field": "mailboxuser",
32042 "field": "mailboxcontext",
32049 "field": "recording",
32076 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32077 "version": "0.0.0",
32078 "filename": "server/api/voiceMailMessage/index.js",
32079 "groupTitle": "Voice_Messages"
32083 "url": "/api/voice/mails/messages/{id}",
32084 "title": "Deletes a Message",
32087 "title": "Example usage:",
32088 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
32092 "name": "DeleteMessages",
32093 "group": "Voice_Messages",
32094 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32095 "version": "0.0.0",
32096 "filename": "server/api/voiceMailMessage/index.js",
32097 "groupTitle": "Voice_Messages"
32101 "url": "/api/voice/mails/messages",
32102 "title": "Gets a list of Messages",
32105 "title": "Example usage:",
32106 "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
32110 "name": "GetMessages",
32111 "group": "Voice_Messages",
32112 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32113 "version": "0.0.0",
32114 "filename": "server/api/voiceMailMessage/index.js",
32115 "groupTitle": "Voice_Messages"
32119 "url": "/api/voice/mails/messages/{id}",
32120 "title": "Gets a single Message",
32123 "title": "Example usage:",
32124 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
32128 "name": "ShowMessages",
32129 "group": "Voice_Messages",
32130 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32131 "version": "0.0.0",
32132 "filename": "server/api/voiceMailMessage/index.js",
32133 "groupTitle": "Voice_Messages"
32137 "url": "voice/mails/messages/{id}/download",
32138 "title": "Download Voice Message",
32141 "title": "Example usage:",
32142 "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
32146 "name": "download",
32147 "group": "Voice_Messages",
32148 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32149 "version": "0.0.0",
32150 "filename": "server/api/voiceMailMessage/index.js",
32151 "groupTitle": "Voice_Messages"
32155 "url": "/api/voice/mails/messages/{id}",
32156 "title": "Update an existing Message",
32159 "title": "Example usage:",
32160 "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",
32164 "name": "updateMessages",
32165 "group": "Voice_Messages",
32166 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32167 "version": "0.0.0",
32168 "filename": "server/api/voiceMailMessage/index.js",
32169 "groupTitle": "Voice_Messages"
32173 "url": "/api/voice/prefixes/{id}/teams",
32174 "title": "Add teams to voice prefix",
32177 "title": "Example usage:",
32178 "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",
32182 "name": "AddTeams",
32183 "group": "Voice_Prefix",
32184 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32185 "version": "0.0.0",
32186 "filename": "server/api/voicePrefix/index.js",
32187 "groupTitle": "Voice_Prefix"
32191 "url": "/api/voice/prefixes/{id}/teams",
32192 "title": "Gets voice prefix team",
32195 "title": "Example usage:",
32196 "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X GET",
32200 "name": "GetTeams",
32201 "group": "Voice_Prefix",
32202 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32203 "version": "0.0.0",
32204 "filename": "server/api/voicePrefix/index.js",
32205 "groupTitle": "Voice_Prefix"
32209 "url": "/api/voice/prefixes/{id}/users",
32210 "title": "Add agents to a prefix",
32213 "title": "Example usage:",
32214 "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",
32218 "name": "AddAgents",
32219 "group": "Voice_Prefixes",
32220 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32221 "version": "0.0.0",
32222 "filename": "server/api/voicePrefix/index.js",
32223 "groupTitle": "Voice_Prefixes"
32227 "url": "/api/voice/prefixes/{id}",
32228 "title": "Deletes a Prefix",
32231 "title": "Example usage:",
32232 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
32236 "name": "DeletePrefixes",
32237 "group": "Voice_Prefixes",
32238 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32239 "version": "0.0.0",
32240 "filename": "server/api/voicePrefix/index.js",
32241 "groupTitle": "Voice_Prefixes"
32245 "url": "/api/voice/prefixes/describe",
32246 "title": "Gets table info about Prefixes",
32249 "title": "Example usage:",
32250 "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
32254 "name": "DescribePrefixes",
32255 "group": "Voice_Prefixes",
32256 "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>",
32257 "version": "0.0.0",
32258 "filename": "server/api/voicePrefix/index.js",
32259 "groupTitle": "Voice_Prefixes"
32263 "url": "/api/voice/prefixes/{id}/users",
32264 "title": "Gets agents from prefix",
32267 "title": "Example usage:",
32268 "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
32272 "name": "GetAgents",
32273 "group": "Voice_Prefixes",
32274 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32275 "version": "0.0.0",
32276 "filename": "server/api/voicePrefix/index.js",
32277 "groupTitle": "Voice_Prefixes"
32281 "url": "/api/voice/prefixes",
32282 "title": "Gets a list of Prefixes",
32285 "title": "Example usage:",
32286 "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
32290 "name": "GetPrefixes",
32291 "group": "Voice_Prefixes",
32292 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32293 "version": "0.0.0",
32294 "filename": "server/api/voicePrefix/index.js",
32295 "groupTitle": "Voice_Prefixes"
32299 "url": "/api/voice/prefixes/{id}/users",
32300 "title": "Removes agents from a prefix",
32303 "title": "Example usage:",
32304 "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32308 "name": "RemoveAgents",
32309 "group": "Voice_Prefixes",
32310 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32311 "version": "0.0.0",
32312 "filename": "server/api/voicePrefix/index.js",
32313 "groupTitle": "Voice_Prefixes"
32317 "url": "/api/voice/prefixes/{id}",
32318 "title": "Gets a single Prefix",
32321 "title": "Example usage:",
32322 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
32326 "name": "ShowPrefixes",
32327 "group": "Voice_Prefixes",
32328 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32329 "version": "0.0.0",
32330 "filename": "server/api/voicePrefix/index.js",
32331 "groupTitle": "Voice_Prefixes"
32335 "url": "/api/voice/prefixes/{id}",
32336 "title": "Update an existing prefix",
32339 "title": "Example usage:",
32340 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
32345 "group": "Voice_Prefixes",
32346 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32347 "version": "0.0.0",
32348 "filename": "server/api/voicePrefix/index.js",
32349 "groupTitle": "Voice_Prefixes"
32353 "url": "/api/voice/prefixes",
32354 "title": "Create a prefix",
32357 "title": "Example usage:",
32358 "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
32363 "group": "Voice_Prefixes",
32364 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32365 "version": "0.0.0",
32366 "filename": "server/api/voicePrefix/index.js",
32367 "groupTitle": "Voice_Prefixes"
32371 "url": "/api/voice/queues/reports/describe",
32372 "title": "Gets table info about Queue Reports",
32375 "title": "Example usage:",
32376 "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
32380 "name": "DescribeQueue_Reports",
32381 "group": "Voice_Queue_Reports",
32382 "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>",
32383 "version": "0.0.0",
32384 "filename": "server/api/voiceQueueReport/index.js",
32385 "groupTitle": "Voice_Queue_Reports"
32389 "url": "/api/voice/queues/reports",
32390 "title": "Gets a list of Queue Reports",
32393 "title": "Example usage:",
32394 "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
32398 "name": "GetQueue_Reports",
32399 "group": "Voice_Queue_Reports",
32400 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32401 "version": "0.0.0",
32402 "filename": "server/api/voiceQueueReport/index.js",
32403 "groupTitle": "Voice_Queue_Reports"
32407 "url": "/api/voice/queues/reports/{id}",
32408 "title": "Gets a single Queue Report",
32411 "title": "Example usage:",
32412 "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
32416 "name": "ShowQueue_Reports",
32417 "group": "Voice_Queue_Reports",
32418 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32419 "version": "0.0.0",
32420 "filename": "server/api/voiceQueueReport/index.js",
32421 "groupTitle": "Voice_Queue_Reports"
32425 "url": "/api/voice/queues/reports/index",
32426 "title": "Get Voice Queues Report",
32429 "title": "Example usage:",
32430 "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
32434 "name": "getVoiceQueuesReport",
32435 "group": "Voice_Queue_Reports",
32436 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32437 "version": "0.0.0",
32438 "filename": "server/api/voiceQueueReport/index.js",
32439 "groupTitle": "Voice_Queue_Reports"
32443 "url": "/api/voice/queues/{id}/users",
32444 "title": "Add agents to queue",
32447 "title": "Example usage:",
32448 "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",
32452 "name": "AddAgents",
32453 "group": "Voice_Queues",
32454 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32455 "version": "0.0.0",
32456 "filename": "server/api/voiceQueue/index.js",
32457 "groupTitle": "Voice_Queues"
32461 "url": "/api/voice/queues/{id}/blacklists",
32462 "title": "Add blacklists to a queue",
32465 "title": "Example usage:",
32466 "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",
32470 "name": "AddBlackLists",
32471 "group": "Voice_Queues",
32472 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32473 "version": "0.0.0",
32474 "filename": "server/api/voiceQueue/index.js",
32475 "groupTitle": "Voice_Queues"
32479 "url": "/api/voice/queues/{id}/lists",
32480 "title": "Add lists to a queue",
32483 "title": "Example usage:",
32484 "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",
32488 "name": "AddLists",
32489 "group": "Voice_Queues",
32490 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32491 "version": "0.0.0",
32492 "filename": "server/api/voiceQueue/index.js",
32493 "groupTitle": "Voice_Queues"
32497 "url": "/api/voice/queues/{id}/teams",
32498 "title": "Add teams to queue",
32501 "title": "Example usage:",
32502 "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",
32506 "name": "AddTeams",
32507 "group": "Voice_Queues",
32508 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32509 "version": "0.0.0",
32510 "filename": "server/api/voiceQueue/index.js",
32511 "groupTitle": "Voice_Queues"
32515 "url": "/api/voice/queues/clone",
32516 "title": "Clone an existing Queue",
32519 "title": "Example usage:",
32520 "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",
32524 "name": "CloneQueues",
32525 "group": "Voice_Queues",
32526 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32527 "version": "0.0.0",
32528 "filename": "server/api/voiceQueue/index.js",
32529 "groupTitle": "Voice_Queues"
32533 "url": "/api/voice/queues",
32534 "title": "Creates a new Queue",
32537 "title": "Example usage:",
32538 "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32542 "name": "CreateQueues",
32543 "group": "Voice_Queues",
32569 "field": "musiconhold",
32576 "field": "announce",
32594 "field": "strategy",
32601 "field": "servicelevel",
32608 "field": "context",
32615 "field": "penaltymemberslimit",
32622 "field": "timeout",
32636 "field": "timeoutpriority",
32650 "field": "wrapuptime",
32661 "field": "autofill",
32673 "field": "autopause",
32680 "field": "autopausedelay",
32691 "field": "autopausebusy",
32702 "field": "autopauseunavail",
32720 "field": "setinterfacevar",
32731 "field": "setqueueentryvar",
32742 "field": "setqueuevar",
32753 "field": "eventmemberstatus",
32760 "field": "membermacro",
32767 "field": "membergosub",
32774 "field": "announce_frequency",
32781 "field": "min_announce_frequency",
32788 "field": "periodic_announce_frequency",
32799 "field": "random_periodic_announce",
32810 "field": "relative_periodic_announce",
32822 "field": "announce_holdtime",
32829 "field": "announce_position",
32840 "field": "announce_to_first_user",
32847 "field": "announce_position_limit",
32862 "field": "announce_round_seconds",
32869 "field": "monitor_format",
32876 "field": "monitor_type",
32883 "field": "queue_youarenext",
32890 "field": "queue_thereare",
32897 "field": "queue_callswaiting",
32904 "field": "queue_holdtime",
32911 "field": "queue_minute",
32918 "field": "queue_minutes",
32925 "field": "queue_seconds",
32932 "field": "queue_thankyou",
32939 "field": "queue_reporthold",
32946 "field": "queue_quantity1",
32953 "field": "queue_quantity2",
32960 "field": "queue_periodic_announce",
32967 "field": "queue_less_than",
32974 "field": "periodic_announce",
32981 "field": "joinempty",
32988 "field": "leavewhenempty",
32999 "field": "reportholdtime",
33010 "field": "ringinuse",
33017 "field": "memberdelay",
33028 "field": "timeoutrestart",
33035 "field": "defaultrule",
33042 "field": "description",
33056 "field": "acwTimeout",
33063 "field": "dialActive",
33064 "description": "<p>Active/Disactive Campaign</p>"
33077 "field": "dialMethod",
33078 "description": "<p>Dial Method.</p>"
33084 "field": "dialLimitChannel",
33085 "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
33091 "field": "dialLimitQueue",
33092 "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
33098 "field": "dialPowerLevel",
33099 "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
33105 "\"agentBusyFactor\"",
33109 "field": "dialPredictiveOptimization",
33110 "description": "<p>Only for predictive method.</p>"
33116 "field": "dialPredictiveOptimizationPercentage",
33117 "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
33123 "field": "dialPredictiveInterval",
33124 "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
33130 "field": "dialOriginateCallerIdName",
33137 "field": "dialOriginateCallerIdNumber",
33144 "field": "dialOriginateTimeout",
33145 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
33151 "field": "dialQueueOptions",
33152 "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
33158 "field": "dialQueueTimeout",
33159 "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
33165 "field": "dialQueueProject",
33166 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
33172 "field": "dialCongestionMaxRetry",
33173 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
33179 "field": "dialCongestionRetryFrequency",
33180 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
33186 "field": "dialBusyMaxRetry",
33187 "description": "<p>#Busy Retry (min:1, max:999)</p>"
33193 "field": "dialBusyRetryFrequency",
33194 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
33200 "field": "dialNoAnswerMaxRetry",
33201 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
33207 "field": "dialNoAnswerRetryFrequency",
33208 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
33214 "field": "dialGlobalMaxRetry",
33215 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
33221 "field": "dialTimezone",
33228 "field": "dialGlobalInterval",
33235 "field": "dialPrefix",
33247 "field": "dialCheckDuplicateType",
33254 "field": "dialAMDActive",
33255 "description": "<p>Active/Disactive AMD</p>"
33261 "field": "dialAMDInitialSilence",
33262 "description": "<p>#AMD Initial Silence</p>"
33268 "field": "dialAMDGreeting",
33269 "description": "<p>#AMD Greeting</p>"
33275 "field": "dialAMDAfterGreetingSilence",
33276 "description": "<p>#AMD After Greeting Silence</p>"
33282 "field": "dialAMDTotalAnalysisTime",
33283 "description": "<p>#AMD Total Analysis Time</p>"
33289 "field": "dialAMDMinWordLength",
33290 "description": "<p>#AMD Min Word Length</p>"
33296 "field": "dialAMDBetweenWordsSilence",
33297 "description": "<p>#AMD Between Words Silence</p>"
33303 "field": "dialAMDMaximumNumberOfWords",
33304 "description": "<p>#AMD Maximum Number Of Words</p>"
33310 "field": "dialAMDSilenceThreshold",
33311 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
33317 "field": "dialAMDMaximumWordLength",
33318 "description": "<p>#AMD Maximum Word Length</p>"
33324 "field": "dialRecallMeTimeout",
33325 "description": "<p>#RecallMe Timeout (min:1)</p>"
33331 "field": "dialRecallInQueue",
33332 "description": "<p>Active/Disactive Recall In Queue</p>"
33342 "field": "dialOrderByScheduledAt",
33349 "field": "dialQueueProject2",
33350 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
33356 "field": "dialAgiAfterHangupClient",
33363 "field": "dialAgiAfterHangupAgent",
33370 "field": "dialRandomLastDigitCallerIdNumber",
33371 "description": "<p>Random Last Digit (min:1, max:15)</p>"
33377 "field": "dialCutDigit",
33378 "description": "<p>Cut Digit (min:1, max:15)</p>"
33384 "field": "dialNoSuchNumberMaxRetry",
33385 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
33391 "field": "dialNoSuchNumberRetryFrequency",
33392 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
33398 "field": "dialDropMaxRetry",
33399 "description": "<p>#Drop Retry (min:1, max:999)</p>"
33405 "field": "dialDropRetryFrequency",
33406 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
33412 "field": "dialAbandonedMaxRetry",
33413 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
33419 "field": "dialAbandonedRetryFrequency",
33420 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
33426 "field": "dialMachineMaxRetry",
33427 "description": "<p>#Machine Retry (min:1, max:999)</p>"
33433 "field": "dialMachineRetryFrequency",
33434 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
33440 "field": "dialAgentRejectMaxRetry",
33441 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
33447 "field": "dialAgentRejectRetryFrequency",
33448 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
33454 "field": "mandatoryDispositionPauseId",
33455 "description": "<p>Status to put when mandatory disposition is enabled</p>"
33461 "field": "mandatoryDisposition",
33462 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
33468 "field": "dialPredictiveIntervalMaxThreshold",
33475 "field": "dialPredictiveIntervalMinThreshold",
33482 "field": "dialPreviewAutoRecallMe",
33488 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33489 "version": "0.0.0",
33490 "filename": "server/api/voiceQueue/index.js",
33491 "groupTitle": "Voice_Queues"
33495 "url": "/api/voice/queues/{id}",
33496 "title": "Deletes a Queue",
33499 "title": "Example usage:",
33500 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
33504 "name": "DeleteQueues",
33505 "group": "Voice_Queues",
33506 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33507 "version": "0.0.0",
33508 "filename": "server/api/voiceQueue/index.js",
33509 "groupTitle": "Voice_Queues"
33513 "url": "/api/voice/queues/{id}/users",
33514 "title": "Gets queue agents",
33517 "title": "Example usage:",
33518 "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
33522 "name": "GetAgents",
33523 "group": "Voice_Queues",
33524 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33525 "version": "0.0.0",
33526 "filename": "server/api/voiceQueue/index.js",
33527 "groupTitle": "Voice_Queues"
33531 "url": "/api/voice/queues/{id}/blacklists",
33532 "title": "Get queue blacklists",
33535 "title": "Example usage:",
33536 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
33540 "name": "GetBlackLists",
33541 "group": "Voice_Queues",
33542 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33543 "version": "0.0.0",
33544 "filename": "server/api/voiceQueue/index.js",
33545 "groupTitle": "Voice_Queues"
33549 "url": "/api/voice/queues/{id}/finals",
33550 "title": "Gets queue hopper finals",
33553 "title": "Example usage:",
33554 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password} -X GET",
33558 "name": "GetHopperFinals",
33559 "group": "Voice_Queues",
33560 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33561 "version": "0.0.0",
33562 "filename": "server/api/voiceQueue/index.js",
33563 "groupTitle": "Voice_Queues"
33567 "url": "/api/voice/queues/{id}/hopper_histories",
33568 "title": "Gets queue hopper histories",
33571 "title": "Example usage:",
33572 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
33576 "name": "GetHopperHistories",
33577 "group": "Voice_Queues",
33578 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33579 "version": "0.0.0",
33580 "filename": "server/api/voiceQueue/index.js",
33581 "groupTitle": "Voice_Queues"
33585 "url": "/api/voice/queues/{id}/hoppers",
33586 "title": "Gets queue hoppers",
33589 "title": "Example usage:",
33590 "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
33594 "name": "GetHoppers",
33595 "group": "Voice_Queues",
33596 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33597 "version": "0.0.0",
33598 "filename": "server/api/voiceQueue/index.js",
33599 "groupTitle": "Voice_Queues"
33603 "url": "/api/voice/queues/{id}/lists",
33604 "title": "Get queue lists",
33607 "title": "Example usage:",
33608 "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
33612 "name": "GetLists",
33613 "group": "Voice_Queues",
33614 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33615 "version": "0.0.0",
33616 "filename": "server/api/voiceQueue/index.js",
33617 "groupTitle": "Voice_Queues"
33621 "url": "/api/voice/queues/{id}/members",
33622 "title": "Gets queue members",
33625 "title": "Example usage:",
33626 "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
33630 "name": "GetMembers",
33631 "group": "Voice_Queues",
33632 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33633 "version": "0.0.0",
33634 "filename": "server/api/voiceQueue/index.js",
33635 "groupTitle": "Voice_Queues"
33639 "url": "/api/voice/queues",
33640 "title": "Gets a list of Queues",
33643 "title": "Example usage:",
33644 "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
33648 "name": "GetQueues",
33649 "group": "Voice_Queues",
33650 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33651 "version": "0.0.0",
33652 "filename": "server/api/voiceQueue/index.js",
33653 "groupTitle": "Voice_Queues"
33657 "url": "/api/voice/queues/{id}/teams",
33658 "title": "Gets queue team",
33661 "title": "Example usage:",
33662 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X GET",
33666 "name": "GetTeams",
33667 "group": "Voice_Queues",
33668 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33669 "version": "0.0.0",
33670 "filename": "server/api/voiceQueue/index.js",
33671 "groupTitle": "Voice_Queues"
33675 "url": "/api/voice/queues/{id}/users",
33676 "title": "Removes agents from a queue",
33679 "title": "Example usage:",
33680 "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33684 "name": "RemoveAgents",
33685 "group": "Voice_Queues",
33686 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33687 "version": "0.0.0",
33688 "filename": "server/api/voiceQueue/index.js",
33689 "groupTitle": "Voice_Queues"
33693 "url": "/api/voice/queues/{id}/blacklists",
33694 "title": "Remove blacklists from a queue",
33697 "title": "Example usage:",
33698 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33702 "name": "RemoveBlackLists",
33703 "group": "Voice_Queues",
33704 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33705 "version": "0.0.0",
33706 "filename": "server/api/voiceQueue/index.js",
33707 "groupTitle": "Voice_Queues"
33711 "url": "/api/voice/queues/{id}/lists",
33712 "title": "Remove lists from a queue",
33715 "title": "Example usage:",
33716 "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33720 "name": "RemoveLists",
33721 "group": "Voice_Queues",
33722 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33723 "version": "0.0.0",
33724 "filename": "server/api/voiceQueue/index.js",
33725 "groupTitle": "Voice_Queues"
33729 "url": "/api/voice/queues/{id}",
33730 "title": "Gets a single Queue",
33733 "title": "Example usage:",
33734 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
33738 "name": "ShowQueues",
33739 "group": "Voice_Queues",
33740 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33741 "version": "0.0.0",
33742 "filename": "server/api/voiceQueue/index.js",
33743 "groupTitle": "Voice_Queues"
33747 "url": "/api/voice/queues/{id}/blacks",
33748 "title": "Gets queue hopper blacks",
33751 "title": "Example usage:",
33752 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password} -X GET",
33756 "name": "getHopperBlacks",
33757 "group": "Voice_Queues",
33758 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33759 "version": "0.0.0",
33760 "filename": "server/api/voiceQueue/index.js",
33761 "groupTitle": "Voice_Queues"
33765 "url": "/api/voice/queues/{id}",
33766 "title": "Update an existing Queue",
33769 "title": "Example usage:",
33770 "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",
33774 "name": "updateQueues",
33775 "group": "Voice_Queues",
33776 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33777 "version": "0.0.0",
33778 "filename": "server/api/voiceQueue/index.js",
33779 "groupTitle": "Voice_Queues"
33783 "url": "/api/voice/recordings",
33784 "title": "Creates a new Recording",
33787 "title": "Example usage:",
33788 "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33792 "name": "CreateRecordings",
33793 "group": "Voice_Recordings",
33808 "field": "uniqueid",
33815 "field": "channel",
33822 "field": "membername",
33829 "field": "calleridnum",
33836 "field": "calleridname",
33843 "field": "connectedlinenum",
33850 "field": "connectedlinename",
33857 "field": "accountcode",
33864 "field": "context",
33906 "field": "userDisposition",
33913 "field": "userSecondDisposition",
33920 "field": "userThirdDisposition",
33927 "field": "location",
33934 "field": "transcribeName",
33941 "field": "transcribeStatus",
33948 "field": "fileUri",
33955 "field": "fileText",
33962 "field": "failureReason",
33969 "field": "sentiment",
33976 "field": "sPositive",
33983 "field": "sNegative",
33990 "field": "sNeutral",
34004 "field": "tempSentiment",
34011 "field": "createdAt",
34018 "field": "updatedAt",
34024 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34025 "version": "0.0.0",
34026 "filename": "server/api/voiceRecording/index.js",
34027 "groupTitle": "Voice_Recordings"
34031 "url": "/api/voice/recordings/describe",
34032 "title": "Gets table info about Recordings",
34035 "title": "Example usage:",
34036 "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
34040 "name": "DescribeRecordings",
34041 "group": "Voice_Recordings",
34042 "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>",
34043 "version": "0.0.0",
34044 "filename": "server/api/voiceRecording/index.js",
34045 "groupTitle": "Voice_Recordings"
34049 "url": "/api/voice/recordings",
34050 "title": "Gets a list of Recordings",
34053 "title": "Example usage:",
34054 "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
34058 "name": "GetRecordings",
34059 "group": "Voice_Recordings",
34060 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34061 "version": "0.0.0",
34062 "filename": "server/api/voiceRecording/index.js",
34063 "groupTitle": "Voice_Recordings"
34067 "url": "/api/voice/recordings/{id}",
34068 "title": "Gets a single Recording",
34071 "title": "Example usage:",
34072 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
34076 "name": "ShowRecordings",
34077 "group": "Voice_Recordings",
34078 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34079 "version": "0.0.0",
34080 "filename": "server/api/voiceRecording/index.js",
34081 "groupTitle": "Voice_Recordings"
34085 "url": "/api/voice/recordings/{id}",
34086 "title": "Delete voice recording",
34089 "title": "Example usage:",
34090 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
34095 "group": "Voice_Recordings",
34096 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34097 "version": "0.0.0",
34098 "filename": "server/api/voiceRecording/index.js",
34099 "groupTitle": "Voice_Recordings"
34103 "url": "/api/voice/recordings/{id}/download",
34104 "title": "Download Recording",
34107 "title": "Example usage:",
34108 "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
34112 "name": "download",
34113 "group": "Voice_Recordings",
34114 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34115 "version": "0.0.0",
34116 "filename": "server/api/voiceRecording/index.js",
34117 "groupTitle": "Voice_Recordings"
34121 "url": "/api/voice/recordings/{id}/downloads",
34122 "title": "Download Recording",
34125 "title": "Example usage:",
34126 "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
34130 "name": "downloads",
34131 "group": "Voice_Recordings",
34132 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34133 "version": "0.0.0",
34134 "filename": "server/api/voiceRecording/index.js",
34135 "groupTitle": "Voice_Recordings"
34139 "url": "/api/voice/recordings/{id}/transcribe",
34140 "title": "Run Transcribe Recording",
34143 "title": "Example usage:",
34144 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
34148 "name": "transcribe",
34149 "group": "Voice_Recordings",
34150 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34151 "version": "0.0.0",
34152 "filename": "server/api/voiceRecording/index.js",
34153 "groupTitle": "Voice_Recordings"
34157 "url": "/api/voice/recordings/{id}/transcribe",
34158 "title": "Run Transcribe Recording",
34161 "title": "Example usage:",
34162 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
34166 "name": "transcribe",
34167 "group": "Voice_Recordings",
34168 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34169 "version": "0.0.0",
34170 "filename": "server/api/voiceRecording/index.js",
34171 "groupTitle": "Voice_Recordings"
34175 "url": "/api/voice/recordings/{id}",
34176 "title": "Update an existing Recording",
34179 "title": "Example usage:",
34180 "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",
34184 "name": "updateRecordings",
34185 "group": "Voice_Recordings",
34186 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34187 "version": "0.0.0",
34188 "filename": "server/api/voiceRecording/index.js",
34189 "groupTitle": "Voice_Recordings"
34193 "url": "/api/voice/transfers/reports",
34194 "title": "Creates a new Transfer Report",
34197 "title": "Example usage:",
34198 "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",
34202 "name": "CreateTransfer_Reports",
34203 "group": "Voice_Transfer_Reports",
34229 "field": "transfererchannel",
34236 "field": "transferercalleridnum",
34243 "field": "transferercalleridname",
34250 "field": "transfererconnectedlinenum",
34257 "field": "transfererconnectedlinename",
34264 "field": "transfereraccountcode",
34271 "field": "transferercontext",
34278 "field": "transfererexten",
34285 "field": "transfererlinkedid",
34292 "field": "transfereechannel",
34299 "field": "transfereecalleridnum",
34306 "field": "transfereecalleridname",
34313 "field": "transfereeconnectedlinenum",
34320 "field": "transfereeconnectedlinename",
34327 "field": "transfereeaccountcode",
34334 "field": "transfereecontext",
34341 "field": "transfereeexten",
34348 "field": "transfereelinkedid",
34359 "field": "isexternal",
34366 "field": "context",
34373 "field": "extension",
34379 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34380 "version": "0.0.0",
34381 "filename": "server/api/voiceTransferReport/index.js",
34382 "groupTitle": "Voice_Transfer_Reports"
34386 "url": "/api/voice/transfers/reports/{id}",
34387 "title": "Deletes a Transfer Report",
34390 "title": "Example usage:",
34391 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
34395 "name": "DeleteTransfer_Reports",
34396 "group": "Voice_Transfer_Reports",
34397 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34398 "version": "0.0.0",
34399 "filename": "server/api/voiceTransferReport/index.js",
34400 "groupTitle": "Voice_Transfer_Reports"
34404 "url": "/api/voice/transfers/reports/describe",
34405 "title": "Gets table info about Transfer Reports",
34408 "title": "Example usage:",
34409 "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
34413 "name": "DescribeTransfer_Reports",
34414 "group": "Voice_Transfer_Reports",
34415 "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>",
34416 "version": "0.0.0",
34417 "filename": "server/api/voiceTransferReport/index.js",
34418 "groupTitle": "Voice_Transfer_Reports"
34422 "url": "/api/voice/transfers/reports",
34423 "title": "Gets a list of Transfer Reports",
34426 "title": "Example usage:",
34427 "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
34431 "name": "GetTransfer_Reports",
34432 "group": "Voice_Transfer_Reports",
34433 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34434 "version": "0.0.0",
34435 "filename": "server/api/voiceTransferReport/index.js",
34436 "groupTitle": "Voice_Transfer_Reports"
34440 "url": "/api/voice/transfers/reports/{id}",
34441 "title": "Gets a single Transfer Report",
34444 "title": "Example usage:",
34445 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
34449 "name": "ShowTransfer_Reports",
34450 "group": "Voice_Transfer_Reports",
34451 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34452 "version": "0.0.0",
34453 "filename": "server/api/voiceTransferReport/index.js",
34454 "groupTitle": "Voice_Transfer_Reports"
34458 "url": "/api/voice/transfers/reports/{id}",
34459 "title": "Update an existing Transfer Report",
34462 "title": "Example usage:",
34463 "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",
34467 "name": "updateTransfer_Reports",
34468 "group": "Voice_Transfer_Reports",
34469 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34470 "version": "0.0.0",
34471 "filename": "server/api/voiceTransferReport/index.js",
34472 "groupTitle": "Voice_Transfer_Reports"
34476 "url": "/api/integrations/vtiger/accounts",
34477 "title": "Creates a new Vtiger Account",
34480 "title": "Example usage:",
34481 "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",
34485 "name": "CreateVtiger_Accounts",
34486 "group": "Vtiger_Accounts",
34501 "field": "description",
34508 "field": "username",
34515 "field": "moduleName",
34522 "field": "remoteUri",
34529 "field": "serverUrl",
34536 "field": "accessKey",
34542 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34543 "version": "0.0.0",
34544 "filename": "server/api/intVtigerAccount/index.js",
34545 "groupTitle": "Vtiger_Accounts"
34549 "url": "/api/integrations/vtiger/accounts/{id}",
34550 "title": "Deletes a Vtiger Account",
34553 "title": "Example usage:",
34554 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
34558 "name": "DeleteVtiger_Accounts",
34559 "group": "Vtiger_Accounts",
34560 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34561 "version": "0.0.0",
34562 "filename": "server/api/intVtigerAccount/index.js",
34563 "groupTitle": "Vtiger_Accounts"
34567 "url": "/api/integrations/vtiger/accounts",
34568 "title": "Gets a list of Vtiger Accounts",
34571 "title": "Example usage:",
34572 "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
34576 "name": "GetVtiger_Accounts",
34577 "group": "Vtiger_Accounts",
34578 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34579 "version": "0.0.0",
34580 "filename": "server/api/intVtigerAccount/index.js",
34581 "groupTitle": "Vtiger_Accounts"
34585 "url": "/api/integrations/vtiger/accounts/{id}",
34586 "title": "Gets a single Vtiger Account",
34589 "title": "Example usage:",
34590 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
34594 "name": "ShowVtiger_Accounts",
34595 "group": "Vtiger_Accounts",
34596 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34597 "version": "0.0.0",
34598 "filename": "server/api/intVtigerAccount/index.js",
34599 "groupTitle": "Vtiger_Accounts"
34603 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34604 "title": "Creates new configuration",
34607 "title": "Example usage:",
34608 "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",
34612 "name": "addConfiguration",
34613 "group": "Vtiger_Accounts",
34614 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34615 "version": "0.0.0",
34616 "filename": "server/api/intVtigerAccount/index.js",
34617 "groupTitle": "Vtiger_Accounts"
34621 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34622 "title": "Gets account configurations",
34625 "title": "Example usage:",
34626 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
34630 "name": "getConfigurations",
34631 "group": "Vtiger_Accounts",
34632 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34633 "version": "0.0.0",
34634 "filename": "server/api/intVtigerAccount/index.js",
34635 "groupTitle": "Vtiger_Accounts"
34639 "url": "/api/integrations/vtiger/accounts/{id}/fields",
34640 "title": "Gets account fields",
34643 "title": "Example usage:",
34644 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
34648 "name": "getFields",
34649 "group": "Vtiger_Accounts",
34650 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34651 "version": "0.0.0",
34652 "filename": "server/api/intVtigerAccount/index.js",
34653 "groupTitle": "Vtiger_Accounts"
34657 "url": "/api/integrations/vtiger/accounts/{id}",
34658 "title": "Update an existing Vtiger Account",
34661 "title": "Example usage:",
34662 "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",
34666 "name": "updateVtiger_Accounts",
34667 "group": "Vtiger_Accounts",
34668 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34669 "version": "0.0.0",
34670 "filename": "server/api/intVtigerAccount/index.js",
34671 "groupTitle": "Vtiger_Accounts"
34675 "url": "/api/integrations/vtiger/configurations",
34676 "title": "Creates a new Vtiger Configuration",
34679 "title": "Example usage:",
34680 "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",
34684 "name": "CreateVtiger_Configurations",
34685 "group": "Vtiger_Configurations",
34700 "field": "description",
34706 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34707 "version": "0.0.0",
34708 "filename": "server/api/intVtigerConfiguration/index.js",
34709 "groupTitle": "Vtiger_Configurations"
34713 "url": "/api/integrations/vtiger/configurations/{id}",
34714 "title": "Deletes a Vtiger Configuration",
34717 "title": "Example usage:",
34718 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
34722 "name": "DeleteVtiger_Configurations",
34723 "group": "Vtiger_Configurations",
34724 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34725 "version": "0.0.0",
34726 "filename": "server/api/intVtigerConfiguration/index.js",
34727 "groupTitle": "Vtiger_Configurations"
34731 "url": "/api/integrations/vtiger/configurations",
34732 "title": "Gets a list of Vtiger Configurations",
34735 "title": "Example usage:",
34736 "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
34740 "name": "GetVtiger_Configurations",
34741 "group": "Vtiger_Configurations",
34742 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34743 "version": "0.0.0",
34744 "filename": "server/api/intVtigerConfiguration/index.js",
34745 "groupTitle": "Vtiger_Configurations"
34749 "url": "/api/integrations/vtiger/configurations/{id}",
34750 "title": "Gets a single Vtiger Configuration",
34753 "title": "Example usage:",
34754 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
34758 "name": "ShowVtiger_Configurations",
34759 "group": "Vtiger_Configurations",
34760 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34761 "version": "0.0.0",
34762 "filename": "server/api/intVtigerConfiguration/index.js",
34763 "groupTitle": "Vtiger_Configurations"
34767 "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
34768 "title": "Gets configurations descriptions",
34771 "title": "Example usage:",
34772 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
34776 "name": "getDescriptions",
34777 "group": "Vtiger_Configurations",
34778 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34779 "version": "0.0.0",
34780 "filename": "server/api/intVtigerConfiguration/index.js",
34781 "groupTitle": "Vtiger_Configurations"
34785 "url": "/api/integrations/vtiger/configurations/{id}/fields",
34786 "title": "Gets configurations fields",
34789 "title": "Example usage:",
34790 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
34794 "name": "getFields",
34795 "group": "Vtiger_Configurations",
34796 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34797 "version": "0.0.0",
34798 "filename": "server/api/intVtigerConfiguration/index.js",
34799 "groupTitle": "Vtiger_Configurations"
34803 "url": "/api/integrations/vtiger/configurations/{id}/subjects",
34804 "title": "Gets configurations subjects",
34807 "title": "Example usage:",
34808 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
34812 "name": "getSubjects",
34813 "group": "Vtiger_Configurations",
34814 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34815 "version": "0.0.0",
34816 "filename": "server/api/intVtigerConfiguration/index.js",
34817 "groupTitle": "Vtiger_Configurations"
34821 "url": "/api/integrations/vtiger/configurations/{id}",
34822 "title": "Update an existing Vtiger Configuration",
34825 "title": "Example usage:",
34826 "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",
34830 "name": "updateVtiger_Configurations",
34831 "group": "Vtiger_Configurations",
34832 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34833 "version": "0.0.0",
34834 "filename": "server/api/intVtigerConfiguration/index.js",
34835 "groupTitle": "Vtiger_Configurations"
34839 "url": "/api/integrations/vtiger/fields",
34840 "title": "Creates a new Vtiger Field",
34843 "title": "Example usage:",
34844 "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",
34848 "name": "CreateVtiger_Fields",
34849 "group": "Vtiger_Fields",
34859 "\"customVariable\"",
34871 "field": "content",
34887 "\"customVariable\""
34890 "field": "keyType",
34897 "field": "keyContent",
34904 "field": "idField",
34911 "field": "nameField",
34918 "field": "customField",
34925 "field": "variableName",
34931 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34932 "version": "0.0.0",
34933 "filename": "server/api/intVtigerField/index.js",
34934 "groupTitle": "Vtiger_Fields"
34938 "url": "/api/integrations/vtiger/fields/{id}",
34939 "title": "Deletes a Vtiger Field",
34942 "title": "Example usage:",
34943 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34947 "name": "DeleteVtiger_Fields",
34948 "group": "Vtiger_Fields",
34949 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34950 "version": "0.0.0",
34951 "filename": "server/api/intVtigerField/index.js",
34952 "groupTitle": "Vtiger_Fields"
34956 "url": "/api/integrations/vtiger/fields",
34957 "title": "Gets a list of Vtiger Fields",
34960 "title": "Example usage:",
34961 "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34965 "name": "GetVtiger_Fields",
34966 "group": "Vtiger_Fields",
34967 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34968 "version": "0.0.0",
34969 "filename": "server/api/intVtigerField/index.js",
34970 "groupTitle": "Vtiger_Fields"
34974 "url": "/api/integrations/vtiger/fields/{id}",
34975 "title": "Gets a single Vtiger Field",
34978 "title": "Example usage:",
34979 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34983 "name": "ShowVtiger_Fields",
34984 "group": "Vtiger_Fields",
34985 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34986 "version": "0.0.0",
34987 "filename": "server/api/intVtigerField/index.js",
34988 "groupTitle": "Vtiger_Fields"
34992 "url": "/api/integrations/vtiger/fields/{id}",
34993 "title": "Update an existing Vtiger Field",
34996 "title": "Example usage:",
34997 "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",
35001 "name": "updateVtiger_Fields",
35002 "group": "Vtiger_Fields",
35003 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35004 "version": "0.0.0",
35005 "filename": "server/api/intVtigerField/index.js",
35006 "groupTitle": "Vtiger_Fields"
35010 "url": "/api/webbar/answer",
35011 "title": "answer webrtc call",
35014 "title": "Example usage:",
35015 "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35019 "name": "Web_Bar_answer",
35028 "field": "sessionId",
35041 "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>",
35042 "version": "0.0.0",
35043 "filename": "server/api/webbar/index.js",
35044 "groupTitle": "WebBar"
35048 "url": "/api/webbar/calls",
35049 "title": "webrtc call list",
35052 "title": "Example usage:",
35053 "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35057 "name": "Web_Bar_calls",
35072 "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>",
35073 "version": "0.0.0",
35074 "filename": "server/api/webbar/index.js",
35075 "groupTitle": "WebBar"
35079 "url": "/api/webbar/hangup",
35080 "title": "hangup webrtc call",
35083 "title": "Example usage:",
35084 "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35088 "name": "Web_Bar_hangup",
35097 "field": "sessionId",
35110 "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>",
35111 "version": "0.0.0",
35112 "filename": "server/api/webbar/index.js",
35113 "groupTitle": "WebBar"
35117 "url": "/api/webbar/hold",
35118 "title": "hold webrtc call",
35121 "title": "Example usage:",
35122 "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35126 "name": "Web_Bar_hold",
35135 "field": "sessionId",
35148 "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>",
35149 "version": "0.0.0",
35150 "filename": "server/api/webbar/index.js",
35151 "groupTitle": "WebBar"
35155 "url": "/api/webbar/unhold",
35156 "title": "unhold webrtc call",
35159 "title": "Example usage:",
35160 "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35164 "name": "Web_Bar_hold",
35173 "field": "sessionId",
35186 "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>",
35187 "version": "0.0.0",
35188 "filename": "server/api/webbar/index.js",
35189 "groupTitle": "WebBar"
35193 "url": "/api/webbar/originate",
35194 "title": "Originate new webrtc call",
35197 "title": "Example usage:",
35198 "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35202 "name": "Web_Bar_originate",
35211 "field": "callNumber",
35225 "field": "callerId",
35232 "field": "callbackUrl",
35238 "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>",
35239 "version": "0.0.0",
35240 "filename": "server/api/webbar/index.js",
35241 "groupTitle": "WebBar"
35245 "url": "/api/webbar/transfer",
35246 "title": "blind transfer webrtc call",
35249 "title": "Example usage:",
35250 "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
35254 "name": "Web_Bar_transfer",
35270 "field": "sessionId",
35277 "field": "transferNumber",
35283 "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>",
35284 "version": "0.0.0",
35285 "filename": "server/api/webbar/index.js",
35286 "groupTitle": "WebBar"
35290 "url": "/api/whatsapp/accounts/{id}/users",
35291 "title": "Add agents to a whatsapp account",
35294 "title": "Example usage:",
35295 "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",
35299 "name": "AddAgents",
35300 "group": "Whatsapp_Accounts",
35301 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35302 "version": "0.0.0",
35303 "filename": "server/api/whatsappAccount/index.js",
35304 "groupTitle": "Whatsapp_Accounts"
35308 "url": "/api/whatsapp/accounts",
35309 "title": "Creates a new Account",
35312 "title": "Example usage:",
35313 "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35317 "name": "CreateAccounts",
35318 "group": "Whatsapp_Accounts",
35371 "field": "accountSid",
35378 "field": "authToken",
35385 "field": "notificationTemplate",
35392 "field": "notificationSound",
35399 "field": "notificationShake",
35406 "field": "waitForTheAssignedAgent",
35413 "field": "waitForTheAssignedQueue",
35420 "field": "queueTransfer",
35427 "field": "queueTransferTimeout",
35434 "field": "agentTransfer",
35441 "field": "agentTransferTimeout",
35448 "field": "mandatoryDispositionPauseId",
35449 "description": "<p>Status to put when mandatory disposition is enabled</p>"
35455 "field": "mandatoryDisposition",
35456 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
35462 "field": "description",
35468 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35469 "version": "0.0.0",
35470 "filename": "server/api/whatsappAccount/index.js",
35471 "groupTitle": "Whatsapp_Accounts"
35475 "url": "/api/whatsapp/accounts/{id}",
35476 "title": "Deletes a Account",
35479 "title": "Example usage:",
35480 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
35484 "name": "DeleteAccounts",
35485 "group": "Whatsapp_Accounts",
35486 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35487 "version": "0.0.0",
35488 "filename": "server/api/whatsappAccount/index.js",
35489 "groupTitle": "Whatsapp_Accounts"
35493 "url": "/api/whatsapp/accounts/describe",
35494 "title": "Gets table info about Accounts",
35497 "title": "Example usage:",
35498 "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
35502 "name": "DescribeAccounts",
35503 "group": "Whatsapp_Accounts",
35504 "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>",
35505 "version": "0.0.0",
35506 "filename": "server/api/whatsappAccount/index.js",
35507 "groupTitle": "Whatsapp_Accounts"
35511 "url": "/api/whatsapp/accounts",
35512 "title": "Gets a list of Accounts",
35515 "title": "Example usage:",
35516 "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
35520 "name": "GetAccounts",
35521 "group": "Whatsapp_Accounts",
35522 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35523 "version": "0.0.0",
35524 "filename": "server/api/whatsappAccount/index.js",
35525 "groupTitle": "Whatsapp_Accounts"
35529 "url": "/api/whatsapp/accounts/{id}/users",
35530 "title": "Gets agents from whatsapp account",
35533 "title": "Example usage:",
35534 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
35538 "name": "GetAgents",
35539 "group": "Whatsapp_Accounts",
35540 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35541 "version": "0.0.0",
35542 "filename": "server/api/whatsappAccount/index.js",
35543 "groupTitle": "Whatsapp_Accounts"
35547 "url": "/api/whatsapp/accounts/{id}/users",
35548 "title": "Removes agents from a whatsapp account",
35551 "title": "Example usage:",
35552 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35556 "name": "RemoveAgents",
35557 "group": "Whatsapp_Accounts",
35558 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35559 "version": "0.0.0",
35560 "filename": "server/api/whatsappAccount/index.js",
35561 "groupTitle": "Whatsapp_Accounts"
35565 "url": "/api/whatsapp/accounts/{id}/canned_answers",
35566 "title": "Removes canned answers from account",
35569 "title": "Example usage:",
35570 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35574 "name": "RemoveAnswers",
35575 "group": "Whatsapp_Accounts",
35576 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35577 "version": "0.0.0",
35578 "filename": "server/api/whatsappAccount/index.js",
35579 "groupTitle": "Whatsapp_Accounts"
35583 "url": "/api/whatsapp/accounts/{id}/dispositions",
35584 "title": "Removes dispositions from account",
35587 "title": "Example usage:",
35588 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35592 "name": "RemoveDispositions",
35593 "group": "Whatsapp_Accounts",
35594 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35595 "version": "0.0.0",
35596 "filename": "server/api/whatsappAccount/index.js",
35597 "groupTitle": "Whatsapp_Accounts"
35601 "url": "/api/whatsapp/accounts/{id}",
35602 "title": "Gets a single Account",
35605 "title": "Example usage:",
35606 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
35610 "name": "ShowAccounts",
35611 "group": "Whatsapp_Accounts",
35612 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35613 "version": "0.0.0",
35614 "filename": "server/api/whatsappAccount/index.js",
35615 "groupTitle": "Whatsapp_Accounts"
35619 "url": "/api/whatsapp/messages/{id}/accept",
35620 "title": "Accepts message",
35623 "title": "Example usage:",
35624 "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35628 "name": "acceptMessage",
35629 "group": "Whatsapp_Accounts",
35630 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35631 "version": "0.0.0",
35632 "filename": "server/api/whatsappMessage/index.js",
35633 "groupTitle": "Whatsapp_Accounts"
35637 "url": "/api/whatsapp/accounts/{id}/canned_answers",
35638 "title": "Creates new canned answer",
35641 "title": "Example usage:",
35642 "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",
35646 "name": "addAnswer",
35647 "group": "Whatsapp_Accounts",
35669 "field": "description",
35682 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35683 "version": "0.0.0",
35684 "filename": "server/api/whatsappAccount/index.js",
35685 "groupTitle": "Whatsapp_Accounts"
35689 "url": "/api/whatsapp/accounts/{id}/applications",
35690 "title": "Creates new applications",
35693 "title": "Example usage:",
35694 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35698 "name": "addApplications",
35699 "group": "Whatsapp_Accounts",
35707 "field": "priority",
35721 "field": "appdata",
35728 "field": "description",
35735 "field": "interval",
35741 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35742 "version": "0.0.0",
35743 "filename": "server/api/whatsappAccount/index.js",
35744 "groupTitle": "Whatsapp_Accounts"
35748 "url": "/api/whatsapp/accounts/{id}/dispositions",
35749 "title": "Creates new disposition",
35752 "title": "Example usage:",
35753 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35757 "name": "addDisposition",
35758 "group": "Whatsapp_Accounts",
35785 "field": "description",
35791 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35792 "version": "0.0.0",
35793 "filename": "server/api/whatsappAccount/index.js",
35794 "groupTitle": "Whatsapp_Accounts"
35798 "url": "/api/whatsapp/accounts/{id}/canned_answers",
35799 "title": "Gets account canned answers",
35802 "title": "Example usage:",
35803 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
35807 "name": "getAnswers",
35808 "group": "Whatsapp_Accounts",
35809 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35810 "version": "0.0.0",
35811 "filename": "server/api/whatsappAccount/index.js",
35812 "groupTitle": "Whatsapp_Accounts"
35816 "url": "/api/whatsapp/accounts/{id}/applications",
35817 "title": "Gets account applications",
35820 "title": "Example usage:",
35821 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
35825 "name": "getApplications",
35826 "group": "Whatsapp_Accounts",
35827 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35828 "version": "0.0.0",
35829 "filename": "server/api/whatsappAccount/index.js",
35830 "groupTitle": "Whatsapp_Accounts"
35834 "url": "/api/whatsapp/accounts/{id}/dispositions",
35835 "title": "Gets account dispositions",
35838 "title": "Example usage:",
35839 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
35843 "name": "getDispositions",
35844 "group": "Whatsapp_Accounts",
35845 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35846 "version": "0.0.0",
35847 "filename": "server/api/whatsappAccount/index.js",
35848 "groupTitle": "Whatsapp_Accounts"
35852 "url": "/api/whatsapp/accounts/{id}/notify",
35853 "title": "Notify new message",
35856 "title": "Example usage:",
35857 "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",
35862 "group": "Whatsapp_Accounts",
35863 "description": "<p>Motion 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>",
35864 "version": "0.0.0",
35865 "filename": "server/api/whatsappAccount/index.js",
35866 "groupTitle": "Whatsapp_Accounts"
35870 "url": "/api/whatsapp/messages/{id}/reject",
35871 "title": "Rejects message",
35874 "title": "Example usage:",
35875 "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35879 "name": "rejectMessage",
35880 "group": "Whatsapp_Accounts",
35881 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35882 "version": "0.0.0",
35883 "filename": "server/api/whatsappMessage/index.js",
35884 "groupTitle": "Whatsapp_Accounts"
35888 "url": "/api/whatsapp/accounts/{id}/send",
35889 "title": "Send new whatsapp message",
35892 "title": "Example usage:",
35893 "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",
35897 "name": "sendWhatsapp",
35898 "group": "Whatsapp_Accounts",
35899 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35900 "version": "0.0.0",
35901 "filename": "server/api/whatsappAccount/index.js",
35902 "groupTitle": "Whatsapp_Accounts"
35906 "url": "/api/whatsapp/messages/{id}/status",
35907 "title": "Receive message status",
35910 "title": "Example usage:",
35911 "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
35915 "name": "statusMessage",
35916 "group": "Whatsapp_Accounts",
35917 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35918 "version": "0.0.0",
35919 "filename": "server/api/whatsappMessage/index.js",
35920 "groupTitle": "Whatsapp_Accounts"
35924 "url": "/api/whatsapp/accounts/{id}",
35925 "title": "Update an existing Account",
35928 "title": "Example usage:",
35929 "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",
35933 "name": "updateAccounts",
35934 "group": "Whatsapp_Accounts",
35935 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35936 "version": "0.0.0",
35937 "filename": "server/api/whatsappAccount/index.js",
35938 "groupTitle": "Whatsapp_Accounts"
35942 "url": "/api/whatsapp/applications",
35943 "title": "Creates a new Application",
35946 "title": "Example usage:",
35947 "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35951 "name": "CreateApplications",
35952 "group": "Whatsapp_Applications",
35960 "field": "priority",
35974 "field": "appdata",
35981 "field": "description",
35988 "field": "interval",
35994 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35995 "version": "0.0.0",
35996 "filename": "server/api/whatsappApplication/index.js",
35997 "groupTitle": "Whatsapp_Applications"
36001 "url": "/api/whatsapp/applications/{id}",
36002 "title": "Deletes a Application",
36005 "title": "Example usage:",
36006 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
36010 "name": "DeleteApplications",
36011 "group": "Whatsapp_Applications",
36012 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36013 "version": "0.0.0",
36014 "filename": "server/api/whatsappApplication/index.js",
36015 "groupTitle": "Whatsapp_Applications"
36019 "url": "/api/whatsapp/applications",
36020 "title": "Gets a list of Applications",
36023 "title": "Example usage:",
36024 "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
36028 "name": "GetApplications",
36029 "group": "Whatsapp_Applications",
36030 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36031 "version": "0.0.0",
36032 "filename": "server/api/whatsappApplication/index.js",
36033 "groupTitle": "Whatsapp_Applications"
36037 "url": "/api/whatsapp/applications/{id}",
36038 "title": "Gets a single Application",
36041 "title": "Example usage:",
36042 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
36046 "name": "ShowApplications",
36047 "group": "Whatsapp_Applications",
36048 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36049 "version": "0.0.0",
36050 "filename": "server/api/whatsappApplication/index.js",
36051 "groupTitle": "Whatsapp_Applications"
36055 "url": "/api/whatsapp/applications/{id}",
36056 "title": "Update an existing Application",
36059 "title": "Example usage:",
36060 "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",
36064 "name": "updateApplications",
36065 "group": "Whatsapp_Applications",
36066 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36067 "version": "0.0.0",
36068 "filename": "server/api/whatsappApplication/index.js",
36069 "groupTitle": "Whatsapp_Applications"
36073 "url": "/api/whatsapp/interactions/{id}/tags",
36074 "title": "Add tags to the interaction",
36077 "title": "Example usage:",
36078 "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",
36083 "group": "Whatsapp_Interactions",
36084 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36085 "version": "0.0.0",
36086 "filename": "server/api/whatsappInteraction/index.js",
36087 "groupTitle": "Whatsapp_Interactions"
36091 "url": "/api/whatsapp/interactions",
36092 "title": "Creates a new Interaction",
36095 "title": "Example usage:",
36096 "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36100 "name": "CreateInteractions",
36101 "group": "Whatsapp_Interactions",
36116 "field": "closedAt",
36123 "field": "disposition",
36130 "field": "secondDisposition",
36137 "field": "thirdDisposition",
36158 "field": "read1stAt",
36169 "field": "firstMsgDirection",
36176 "field": "lastMsgAt",
36187 "field": "lastMsgDirection",
36194 "field": "autoreplyExecuted",
36200 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36201 "version": "0.0.0",
36202 "filename": "server/api/whatsappInteraction/index.js",
36203 "groupTitle": "Whatsapp_Interactions"
36207 "url": "/api/whatsapp/interactions/{id}",
36208 "title": "Deletes a Interaction",
36211 "title": "Example usage:",
36212 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
36216 "name": "DeleteInteractions",
36217 "group": "Whatsapp_Interactions",
36218 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36219 "version": "0.0.0",
36220 "filename": "server/api/whatsappInteraction/index.js",
36221 "groupTitle": "Whatsapp_Interactions"
36225 "url": "/api/whatsapp/interactions/describe",
36226 "title": "Gets table info about Interactions",
36229 "title": "Example usage:",
36230 "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
36234 "name": "DescribeInteractions",
36235 "group": "Whatsapp_Interactions",
36236 "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>",
36237 "version": "0.0.0",
36238 "filename": "server/api/whatsappInteraction/index.js",
36239 "groupTitle": "Whatsapp_Interactions"
36243 "url": "/api/whatsapp/interactions",
36244 "title": "Gets a list of Interactions",
36247 "title": "Example usage:",
36248 "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
36252 "name": "GetInteractions",
36253 "group": "Whatsapp_Interactions",
36254 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36255 "version": "0.0.0",
36256 "filename": "server/api/whatsappInteraction/index.js",
36257 "groupTitle": "Whatsapp_Interactions"
36261 "url": "/api/whatsapp/interactions/{id}/tags",
36262 "title": "Removes tags from interaction",
36265 "title": "Example usage:",
36266 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36270 "name": "RemoveTags",
36271 "group": "Whatsapp_Interactions",
36272 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36273 "version": "0.0.0",
36274 "filename": "server/api/whatsappInteraction/index.js",
36275 "groupTitle": "Whatsapp_Interactions"
36279 "url": "/api/whatsapp/interactions/{id}",
36280 "title": "Gets a single Interaction",
36283 "title": "Example usage:",
36284 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
36288 "name": "ShowInteractions",
36289 "group": "Whatsapp_Interactions",
36290 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/whatsappInteraction/index.js",
36293 "groupTitle": "Whatsapp_Interactions"
36297 "url": "/api/whatsapp/interactions/{id}/messages",
36298 "title": "Creates new messages",
36301 "title": "Example usage:",
36302 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
36306 "name": "addMessage",
36307 "group": "Whatsapp_Interactions",
36333 "field": "direction",
36340 "field": "messageId",
36368 "field": "providerName",
36375 "field": "providerResponse",
36381 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36382 "version": "0.0.0",
36383 "filename": "server/api/whatsappInteraction/index.js",
36384 "groupTitle": "Whatsapp_Interactions"
36388 "url": "/api/whatsapp/interactions/{id}/download",
36389 "title": "Gets interaction",
36392 "title": "Example usage:",
36393 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
36397 "name": "download",
36398 "group": "Whatsapp_Interactions",
36399 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36400 "version": "0.0.0",
36401 "filename": "server/api/whatsappInteraction/index.js",
36402 "groupTitle": "Whatsapp_Interactions"
36406 "url": "/api/whatsapp/interactions/{id}/messages",
36407 "title": "Gets interaction messages",
36410 "title": "Example usage:",
36411 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
36415 "name": "getMessages",
36416 "group": "Whatsapp_Interactions",
36417 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36418 "version": "0.0.0",
36419 "filename": "server/api/whatsappInteraction/index.js",
36420 "groupTitle": "Whatsapp_Interactions"
36424 "url": "/api/whatsapp/interactions/{id}",
36425 "title": "Update an existing Interaction",
36428 "title": "Example usage:",
36429 "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",
36433 "name": "updateInteractions",
36434 "group": "Whatsapp_Interactions",
36435 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36436 "version": "0.0.0",
36437 "filename": "server/api/whatsappInteraction/index.js",
36438 "groupTitle": "Whatsapp_Interactions"
36442 "url": "/api/whatsapp/messages",
36443 "title": "Creates a new Message",
36446 "title": "Example usage:",
36447 "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36451 "name": "CreateMessages",
36452 "group": "Whatsapp_Messages",
36478 "field": "direction",
36485 "field": "messageId",
36513 "field": "providerName",
36520 "field": "providerResponse",
36526 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36527 "version": "0.0.0",
36528 "filename": "server/api/whatsappMessage/index.js",
36529 "groupTitle": "Whatsapp_Messages"
36533 "url": "/api/whatsapp/messages/{id}",
36534 "title": "Deletes a Message",
36537 "title": "Example usage:",
36538 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
36542 "name": "DeleteMessages",
36543 "group": "Whatsapp_Messages",
36544 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36545 "version": "0.0.0",
36546 "filename": "server/api/whatsappMessage/index.js",
36547 "groupTitle": "Whatsapp_Messages"
36551 "url": "/api/whatsapp/messages/describe",
36552 "title": "Gets table info about Messages",
36555 "title": "Example usage:",
36556 "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
36560 "name": "DescribeMessages",
36561 "group": "Whatsapp_Messages",
36562 "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>",
36563 "version": "0.0.0",
36564 "filename": "server/api/whatsappMessage/index.js",
36565 "groupTitle": "Whatsapp_Messages"
36569 "url": "/api/whatsapp/messages",
36570 "title": "Gets a list of Messages",
36573 "title": "Example usage:",
36574 "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
36578 "name": "GetMessages",
36579 "group": "Whatsapp_Messages",
36580 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36581 "version": "0.0.0",
36582 "filename": "server/api/whatsappMessage/index.js",
36583 "groupTitle": "Whatsapp_Messages"
36587 "url": "/api/whatsapp/messages/{id}",
36588 "title": "Gets a single Message",
36591 "title": "Example usage:",
36592 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
36596 "name": "ShowMessages",
36597 "group": "Whatsapp_Messages",
36598 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36599 "version": "0.0.0",
36600 "filename": "server/api/whatsappMessage/index.js",
36601 "groupTitle": "Whatsapp_Messages"
36605 "url": "/api/whatsapp/messages/{id}",
36606 "title": "Update an existing Message",
36609 "title": "Example usage:",
36610 "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",
36614 "name": "updateMessages",
36615 "group": "Whatsapp_Messages",
36616 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36617 "version": "0.0.0",
36618 "filename": "server/api/whatsappMessage/index.js",
36619 "groupTitle": "Whatsapp_Messages"
36623 "url": "/api/whatsapp/reports/queue",
36624 "title": "Creates a new Whatsapp Queue Report",
36627 "title": "Example usage:",
36628 "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",
36632 "name": "CreateWhatsapp_Queue_Reports",
36633 "group": "Whatsapp_Queue_Reports",
36641 "field": "uniqueid",
36662 "field": "leaveAt",
36669 "field": "acceptAt",
36689 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36690 "version": "0.0.0",
36691 "filename": "server/api/whatsappQueueReport/index.js",
36692 "groupTitle": "Whatsapp_Queue_Reports"
36696 "url": "/api/whatsapp/reports/queue/{id}",
36697 "title": "Deletes a Whatsapp Queue Report",
36700 "title": "Example usage:",
36701 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
36705 "name": "DeleteWhatsapp_Queue_Reports",
36706 "group": "Whatsapp_Queue_Reports",
36707 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36708 "version": "0.0.0",
36709 "filename": "server/api/whatsappQueueReport/index.js",
36710 "groupTitle": "Whatsapp_Queue_Reports"
36714 "url": "/api/whatsapp/reports/queue/describe",
36715 "title": "Gets table info about Whatsapp Queue Reports",
36718 "title": "Example usage:",
36719 "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
36723 "name": "DescribeWhatsapp_Queue_Reports",
36724 "group": "Whatsapp_Queue_Reports",
36725 "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>",
36726 "version": "0.0.0",
36727 "filename": "server/api/whatsappQueueReport/index.js",
36728 "groupTitle": "Whatsapp_Queue_Reports"
36732 "url": "/api/whatsapp/reports/queue",
36733 "title": "Gets a list of Whatsapp Queue Reports",
36736 "title": "Example usage:",
36737 "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
36741 "name": "GetWhatsapp_Queue_Reports",
36742 "group": "Whatsapp_Queue_Reports",
36743 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36744 "version": "0.0.0",
36745 "filename": "server/api/whatsappQueueReport/index.js",
36746 "groupTitle": "Whatsapp_Queue_Reports"
36750 "url": "/api/whatsapp/reports/queue/{id}",
36751 "title": "Gets a single Whatsapp Queue Report",
36754 "title": "Example usage:",
36755 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
36759 "name": "ShowWhatsapp_Queue_Reports",
36760 "group": "Whatsapp_Queue_Reports",
36761 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36762 "version": "0.0.0",
36763 "filename": "server/api/whatsappQueueReport/index.js",
36764 "groupTitle": "Whatsapp_Queue_Reports"
36768 "url": "/api/whatsapp/reports/queue/{id}",
36769 "title": "Update an existing Whatsapp Queue Report",
36772 "title": "Example usage:",
36773 "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",
36777 "name": "updateWhatsapp_Queue_Reports",
36778 "group": "Whatsapp_Queue_Reports",
36779 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36780 "version": "0.0.0",
36781 "filename": "server/api/whatsappQueueReport/index.js",
36782 "groupTitle": "Whatsapp_Queue_Reports"
36786 "url": "/api/whatsapp/queues/{id}/users",
36787 "title": "Add agents to a queue",
36790 "title": "Example usage:",
36791 "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",
36795 "name": "AddAgents",
36796 "group": "Whatsapp_Queues",
36797 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36798 "version": "0.0.0",
36799 "filename": "server/api/whatsappQueue/index.js",
36800 "groupTitle": "Whatsapp_Queues"
36804 "url": "/api/whatsapp/queues/{id}/teams",
36805 "title": "Add teams to a queue",
36808 "title": "Example usage:",
36809 "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",
36813 "name": "AddTeams",
36814 "group": "Whatsapp_Queues",
36815 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36816 "version": "0.0.0",
36817 "filename": "server/api/whatsappQueue/index.js",
36818 "groupTitle": "Whatsapp_Queues"
36822 "url": "/api/whatsapp/queues",
36823 "title": "Creates a new Queue",
36826 "title": "Example usage:",
36827 "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36831 "name": "CreateQueues",
36832 "group": "Whatsapp_Queues",
36847 "field": "timeout",
36859 "field": "strategy",
36866 "field": "description",
36872 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36873 "version": "0.0.0",
36874 "filename": "server/api/whatsappQueue/index.js",
36875 "groupTitle": "Whatsapp_Queues"
36879 "url": "/api/whatsapp/queues/{id}",
36880 "title": "Deletes a Queue",
36883 "title": "Example usage:",
36884 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
36888 "name": "DeleteQueues",
36889 "group": "Whatsapp_Queues",
36890 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36891 "version": "0.0.0",
36892 "filename": "server/api/whatsappQueue/index.js",
36893 "groupTitle": "Whatsapp_Queues"
36897 "url": "/api/whatsapp/queues/describe",
36898 "title": "Gets table info about Queues",
36901 "title": "Example usage:",
36902 "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
36906 "name": "DescribeQueues",
36907 "group": "Whatsapp_Queues",
36908 "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>",
36909 "version": "0.0.0",
36910 "filename": "server/api/whatsappQueue/index.js",
36911 "groupTitle": "Whatsapp_Queues"
36915 "url": "/api/whatsapp/queues/{id}/users",
36916 "title": "Gets queue agents",
36919 "title": "Example usage:",
36920 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
36924 "name": "GetAgents",
36925 "group": "Whatsapp_Queues",
36926 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36927 "version": "0.0.0",
36928 "filename": "server/api/whatsappQueue/index.js",
36929 "groupTitle": "Whatsapp_Queues"
36933 "url": "/api/whatsapp/queues/{id}/members",
36934 "title": "GetMembers",
36937 "title": "Example usage:",
36938 "content": "curl https://{domain}/api/whatsapp/queues/{id}/members -v -u {name}:{password}",
36942 "name": "GetMembers",
36943 "group": "Whatsapp_Queues",
36944 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36945 "version": "0.0.0",
36946 "filename": "server/api/whatsappQueue/index.js",
36947 "groupTitle": "Whatsapp_Queues"
36951 "url": "/api/whatsapp/queues",
36952 "title": "Gets a list of Queues",
36955 "title": "Example usage:",
36956 "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
36960 "name": "GetQueues",
36961 "group": "Whatsapp_Queues",
36962 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36963 "version": "0.0.0",
36964 "filename": "server/api/whatsappQueue/index.js",
36965 "groupTitle": "Whatsapp_Queues"
36969 "url": "/api/whatsapp/queues/{id}/teams",
36970 "title": "Gets queues list",
36973 "title": "Example usage:",
36974 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36978 "name": "GetTeams",
36979 "group": "Whatsapp_Queues",
36980 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36981 "version": "0.0.0",
36982 "filename": "server/api/whatsappQueue/index.js",
36983 "groupTitle": "Whatsapp_Queues"
36987 "url": "/api/whatsapp/queues/{id}/users",
36988 "title": "Removes agents from a queue",
36991 "title": "Example usage:",
36992 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36996 "name": "RemoveAgents",
36997 "group": "Whatsapp_Queues",
36998 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36999 "version": "0.0.0",
37000 "filename": "server/api/whatsappQueue/index.js",
37001 "groupTitle": "Whatsapp_Queues"
37005 "url": "/api/whatsapp/queues/{id}",
37006 "title": "Gets a single Queue",
37009 "title": "Example usage:",
37010 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
37014 "name": "ShowQueues",
37015 "group": "Whatsapp_Queues",
37016 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37017 "version": "0.0.0",
37018 "filename": "server/api/whatsappQueue/index.js",
37019 "groupTitle": "Whatsapp_Queues"
37023 "url": "/api/whatsapp/queues/{id}",
37024 "title": "Update an existing Queue",
37027 "title": "Example usage:",
37028 "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",
37032 "name": "updateQueues",
37033 "group": "Whatsapp_Queues",
37034 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37035 "version": "0.0.0",
37036 "filename": "server/api/whatsappQueue/index.js",
37037 "groupTitle": "Whatsapp_Queues"
37041 "url": "/api/whatsapp/reports/transfer",
37042 "title": "Creates a new Whatsapp Transfer Report",
37045 "title": "Example usage:",
37046 "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",
37050 "name": "CreateWhatsapp_Transfer_Reports",
37051 "group": "Whatsapp_Transfer_Reports",
37059 "field": "uniqueid",
37078 "field": "transferredAt",
37084 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37085 "version": "0.0.0",
37086 "filename": "server/api/whatsappTransferReport/index.js",
37087 "groupTitle": "Whatsapp_Transfer_Reports"
37091 "url": "/api/whatsapp/reports/transfer/{id}",
37092 "title": "Deletes a Whatsapp Transfer Report",
37095 "title": "Example usage:",
37096 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
37100 "name": "DeleteWhatsapp_Transfer_Reports",
37101 "group": "Whatsapp_Transfer_Reports",
37102 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37103 "version": "0.0.0",
37104 "filename": "server/api/whatsappTransferReport/index.js",
37105 "groupTitle": "Whatsapp_Transfer_Reports"
37109 "url": "/api/whatsapp/reports/transfer/describe",
37110 "title": "Gets table info about Whatsapp Transfer Reports",
37113 "title": "Example usage:",
37114 "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
37118 "name": "DescribeWhatsapp_Transfer_Reports",
37119 "group": "Whatsapp_Transfer_Reports",
37120 "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>",
37121 "version": "0.0.0",
37122 "filename": "server/api/whatsappTransferReport/index.js",
37123 "groupTitle": "Whatsapp_Transfer_Reports"
37127 "url": "/api/whatsapp/reports/transfer",
37128 "title": "Gets a list of Whatsapp Transfer Reports",
37131 "title": "Example usage:",
37132 "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
37136 "name": "GetWhatsapp_Transfer_Reports",
37137 "group": "Whatsapp_Transfer_Reports",
37138 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37139 "version": "0.0.0",
37140 "filename": "server/api/whatsappTransferReport/index.js",
37141 "groupTitle": "Whatsapp_Transfer_Reports"
37145 "url": "/api/whatsapp/reports/transfer/{id}",
37146 "title": "Gets a single Whatsapp Transfer Report",
37149 "title": "Example usage:",
37150 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
37154 "name": "ShowWhatsapp_Transfer_Reports",
37155 "group": "Whatsapp_Transfer_Reports",
37156 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37157 "version": "0.0.0",
37158 "filename": "server/api/whatsappTransferReport/index.js",
37159 "groupTitle": "Whatsapp_Transfer_Reports"
37163 "url": "/api/whatsapp/reports/transfer/{id}",
37164 "title": "Update an existing Whatsapp Transfer Report",
37167 "title": "Example usage:",
37168 "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",
37172 "name": "updateWhatsapp_Transfer_Reports",
37173 "group": "Whatsapp_Transfer_Reports",
37174 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37175 "version": "0.0.0",
37176 "filename": "server/api/whatsappTransferReport/index.js",
37177 "groupTitle": "Whatsapp_Transfer_Reports"
37181 "url": "/api/integrations/zendesk/accounts",
37182 "title": "Creates a new Zendesk Account",
37185 "title": "Example usage:",
37186 "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",
37190 "name": "CreateZendesk_Accounts",
37191 "group": "Zendesk_Accounts",
37206 "field": "description",
37213 "field": "username",
37220 "field": "password",
37234 "field": "remoteUri",
37245 "field": "authType",
37252 "field": "serverUrl",
37259 "\"integrationTab\"",
37269 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37270 "version": "0.0.0",
37271 "filename": "server/api/intZendeskAccount/index.js",
37272 "groupTitle": "Zendesk_Accounts"
37276 "url": "/api/integrations/zendesk/accounts/{id}",
37277 "title": "Deletes a Zendesk Account",
37280 "title": "Example usage:",
37281 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
37285 "name": "DeleteZendesk_Accounts",
37286 "group": "Zendesk_Accounts",
37287 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37288 "version": "0.0.0",
37289 "filename": "server/api/intZendeskAccount/index.js",
37290 "groupTitle": "Zendesk_Accounts"
37294 "url": "/api/integrations/zendesk/accounts",
37295 "title": "Gets a list of Zendesk Accounts",
37298 "title": "Example usage:",
37299 "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
37303 "name": "GetZendesk_Accounts",
37304 "group": "Zendesk_Accounts",
37305 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37306 "version": "0.0.0",
37307 "filename": "server/api/intZendeskAccount/index.js",
37308 "groupTitle": "Zendesk_Accounts"
37312 "url": "/api/integrations/zendesk/accounts/{id}",
37313 "title": "Gets a single Zendesk Account",
37316 "title": "Example usage:",
37317 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
37321 "name": "ShowZendesk_Accounts",
37322 "group": "Zendesk_Accounts",
37323 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37324 "version": "0.0.0",
37325 "filename": "server/api/intZendeskAccount/index.js",
37326 "groupTitle": "Zendesk_Accounts"
37330 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
37331 "title": "Creates new configuration",
37334 "title": "Example usage:",
37335 "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",
37339 "name": "addConfiguration",
37340 "group": "Zendesk_Accounts",
37341 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37342 "version": "0.0.0",
37343 "filename": "server/api/intZendeskAccount/index.js",
37344 "groupTitle": "Zendesk_Accounts"
37348 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
37349 "title": "Gets account configurations",
37352 "title": "Example usage:",
37353 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37357 "name": "getConfigurations",
37358 "group": "Zendesk_Accounts",
37359 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37360 "version": "0.0.0",
37361 "filename": "server/api/intZendeskAccount/index.js",
37362 "groupTitle": "Zendesk_Accounts"
37366 "url": "/api/integrations/zendesk/accounts/{id}/fields",
37367 "title": "Gets account fields",
37370 "title": "Example usage:",
37371 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
37375 "name": "getFields",
37376 "group": "Zendesk_Accounts",
37377 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37378 "version": "0.0.0",
37379 "filename": "server/api/intZendeskAccount/index.js",
37380 "groupTitle": "Zendesk_Accounts"
37384 "url": "/api/integrations/zendesk/accounts/{id}",
37385 "title": "Update an existing Zendesk Account",
37388 "title": "Example usage:",
37389 "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",
37393 "name": "updateZendesk_Accounts",
37394 "group": "Zendesk_Accounts",
37395 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37396 "version": "0.0.0",
37397 "filename": "server/api/intZendeskAccount/index.js",
37398 "groupTitle": "Zendesk_Accounts"
37402 "url": "/api/integrations/zendesk/configurations",
37403 "title": "Creates a new Zendesk Configuration",
37406 "title": "Example usage:",
37407 "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",
37411 "name": "CreateZendesk_Configurations",
37412 "group": "Zendesk_Configurations",
37427 "field": "description",
37433 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37434 "version": "0.0.0",
37435 "filename": "server/api/intZendeskConfiguration/index.js",
37436 "groupTitle": "Zendesk_Configurations"
37440 "url": "/api/integrations/zendesk/configurations/{id}",
37441 "title": "Deletes a Zendesk Configuration",
37444 "title": "Example usage:",
37445 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
37449 "name": "DeleteZendesk_Configurations",
37450 "group": "Zendesk_Configurations",
37451 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37452 "version": "0.0.0",
37453 "filename": "server/api/intZendeskConfiguration/index.js",
37454 "groupTitle": "Zendesk_Configurations"
37458 "url": "/api/integrations/zendesk/configurations",
37459 "title": "Gets a list of Zendesk Configurations",
37462 "title": "Example usage:",
37463 "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
37467 "name": "GetZendesk_Configurations",
37468 "group": "Zendesk_Configurations",
37469 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37470 "version": "0.0.0",
37471 "filename": "server/api/intZendeskConfiguration/index.js",
37472 "groupTitle": "Zendesk_Configurations"
37476 "url": "/api/integrations/zendesk/configurations/{id}",
37477 "title": "Gets a single Zendesk Configuration",
37480 "title": "Example usage:",
37481 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
37485 "name": "ShowZendesk_Configurations",
37486 "group": "Zendesk_Configurations",
37487 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37488 "version": "0.0.0",
37489 "filename": "server/api/intZendeskConfiguration/index.js",
37490 "groupTitle": "Zendesk_Configurations"
37494 "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
37495 "title": "Gets configurations descriptions",
37498 "title": "Example usage:",
37499 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37503 "name": "getDescriptions",
37504 "group": "Zendesk_Configurations",
37505 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37506 "version": "0.0.0",
37507 "filename": "server/api/intZendeskConfiguration/index.js",
37508 "groupTitle": "Zendesk_Configurations"
37512 "url": "/api/integrations/zendesk/configurations/{id}/fields",
37513 "title": "Gets configurations fields",
37516 "title": "Example usage:",
37517 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
37521 "name": "getFields",
37522 "group": "Zendesk_Configurations",
37523 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37524 "version": "0.0.0",
37525 "filename": "server/api/intZendeskConfiguration/index.js",
37526 "groupTitle": "Zendesk_Configurations"
37530 "url": "/api/integrations/zendesk/configurations/{id}/subjects",
37531 "title": "Gets configurations subjects",
37534 "title": "Example usage:",
37535 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37539 "name": "getSubjects",
37540 "group": "Zendesk_Configurations",
37541 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37542 "version": "0.0.0",
37543 "filename": "server/api/intZendeskConfiguration/index.js",
37544 "groupTitle": "Zendesk_Configurations"
37548 "url": "/api/integrations/zendesk/configurations/{id}/tags",
37549 "title": "Gets configurations tags",
37552 "title": "Example usage:",
37553 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
37558 "group": "Zendesk_Configurations",
37559 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37560 "version": "0.0.0",
37561 "filename": "server/api/intZendeskConfiguration/index.js",
37562 "groupTitle": "Zendesk_Configurations"
37566 "url": "/api/integrations/zendesk/configurations/{id}/tags",
37567 "title": "Sets new tags",
37570 "title": "Example usage:",
37571 "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",
37576 "group": "Zendesk_Configurations",
37577 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37578 "version": "0.0.0",
37579 "filename": "server/api/intZendeskConfiguration/index.js",
37580 "groupTitle": "Zendesk_Configurations"
37584 "url": "/api/integrations/zendesk/configurations/{id}",
37585 "title": "Update an existing Zendesk Configuration",
37588 "title": "Example usage:",
37589 "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",
37593 "name": "updateZendesk_Configurations",
37594 "group": "Zendesk_Configurations",
37595 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37596 "version": "0.0.0",
37597 "filename": "server/api/intZendeskConfiguration/index.js",
37598 "groupTitle": "Zendesk_Configurations"
37602 "url": "/api/integrations/zendesk/fields",
37603 "title": "Creates a new Zendesk Field",
37606 "title": "Example usage:",
37607 "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",
37611 "name": "CreateZendesk_Fields",
37612 "group": "Zendesk_Fields",
37622 "\"customVariable\"",
37634 "field": "content",
37650 "\"customVariable\""
37653 "field": "keyType",
37660 "field": "keyContent",
37667 "field": "idField",
37674 "field": "nameField",
37681 "field": "customField",
37688 "field": "variableName",
37694 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37695 "version": "0.0.0",
37696 "filename": "server/api/intZendeskField/index.js",
37697 "groupTitle": "Zendesk_Fields"
37701 "url": "/api/integrations/zendesk/fields/{id}",
37702 "title": "Deletes a Zendesk Field",
37705 "title": "Example usage:",
37706 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
37710 "name": "DeleteZendesk_Fields",
37711 "group": "Zendesk_Fields",
37712 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37713 "version": "0.0.0",
37714 "filename": "server/api/intZendeskField/index.js",
37715 "groupTitle": "Zendesk_Fields"
37719 "url": "/api/integrations/zendesk/fields",
37720 "title": "Gets a list of Zendesk Fields",
37723 "title": "Example usage:",
37724 "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
37728 "name": "GetZendesk_Fields",
37729 "group": "Zendesk_Fields",
37730 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37731 "version": "0.0.0",
37732 "filename": "server/api/intZendeskField/index.js",
37733 "groupTitle": "Zendesk_Fields"
37737 "url": "/api/integrations/zendesk/fields/{id}",
37738 "title": "Gets a single Zendesk Field",
37741 "title": "Example usage:",
37742 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
37746 "name": "ShowZendesk_Fields",
37747 "group": "Zendesk_Fields",
37748 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37749 "version": "0.0.0",
37750 "filename": "server/api/intZendeskField/index.js",
37751 "groupTitle": "Zendesk_Fields"
37755 "url": "/api/integrations/zendesk/fields/{id}",
37756 "title": "Update an existing Zendesk Field",
37759 "title": "Example usage:",
37760 "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",
37764 "name": "updateZendesk_Fields",
37765 "group": "Zendesk_Fields",
37766 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37767 "version": "0.0.0",
37768 "filename": "server/api/intZendeskField/index.js",
37769 "groupTitle": "Zendesk_Fields"
37773 "url": "/api/integrations/zoho/accounts",
37774 "title": "Creates a new Zoho Account",
37777 "title": "Example usage:",
37778 "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",
37782 "name": "CreateZoho_Accounts",
37783 "group": "Zoho_Accounts",
37798 "field": "description",
37819 "field": "clientId",
37826 "field": "clientSecret",
37833 "field": "serverUrl",
37847 "field": "refreshToken",
37853 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37854 "version": "0.0.0",
37855 "filename": "server/api/intZohoAccount/index.js",
37856 "groupTitle": "Zoho_Accounts"
37860 "url": "/api/integrations/zoho/accounts/{id}",
37861 "title": "Deletes a Zoho Account",
37864 "title": "Example usage:",
37865 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
37869 "name": "DeleteZoho_Accounts",
37870 "group": "Zoho_Accounts",
37871 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37872 "version": "0.0.0",
37873 "filename": "server/api/intZohoAccount/index.js",
37874 "groupTitle": "Zoho_Accounts"
37878 "url": "/api/integrations/zoho/accounts",
37879 "title": "Gets a list of Zoho Accounts",
37882 "title": "Example usage:",
37883 "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
37887 "name": "GetZoho_Accounts",
37888 "group": "Zoho_Accounts",
37889 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37890 "version": "0.0.0",
37891 "filename": "server/api/intZohoAccount/index.js",
37892 "groupTitle": "Zoho_Accounts"
37896 "url": "/api/integrations/zoho/accounts/{id}",
37897 "title": "Gets a single Zoho Account",
37900 "title": "Example usage:",
37901 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
37905 "name": "ShowZoho_Accounts",
37906 "group": "Zoho_Accounts",
37907 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37908 "version": "0.0.0",
37909 "filename": "server/api/intZohoAccount/index.js",
37910 "groupTitle": "Zoho_Accounts"
37914 "url": "/api/integrations/zoho/accounts/{id}/configurations",
37915 "title": "Creates new configuration",
37918 "title": "Example usage:",
37919 "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",
37923 "name": "addConfiguration",
37924 "group": "Zoho_Accounts",
37925 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37926 "version": "0.0.0",
37927 "filename": "server/api/intZohoAccount/index.js",
37928 "groupTitle": "Zoho_Accounts"
37932 "url": "/api/integrations/zoho/accounts/{id}/configurations",
37933 "title": "Gets account configurations",
37936 "title": "Example usage:",
37937 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37941 "name": "getConfigurations",
37942 "group": "Zoho_Accounts",
37943 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37944 "version": "0.0.0",
37945 "filename": "server/api/intZohoAccount/index.js",
37946 "groupTitle": "Zoho_Accounts"
37950 "url": "/api/integrations/zoho/accounts/{id}/fields",
37951 "title": "Gets account fields",
37954 "title": "Example usage:",
37955 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
37959 "name": "getFields",
37960 "group": "Zoho_Accounts",
37961 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37962 "version": "0.0.0",
37963 "filename": "server/api/intZohoAccount/index.js",
37964 "groupTitle": "Zoho_Accounts"
37968 "url": "/api/integrations/zoho/accounts/{id}",
37969 "title": "Update an existing Zoho Account",
37972 "title": "Example usage:",
37973 "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",
37977 "name": "updateZoho_Accounts",
37978 "group": "Zoho_Accounts",
37979 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37980 "version": "0.0.0",
37981 "filename": "server/api/intZohoAccount/index.js",
37982 "groupTitle": "Zoho_Accounts"
37986 "url": "/api/integrations/zoho/configurations",
37987 "title": "Creates a new Zoho Configuration",
37990 "title": "Example usage:",
37991 "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",
37995 "name": "CreateZoho_Configurations",
37996 "group": "Zoho_Configurations",
38016 "field": "moduleCreate",
38023 "\"contact_lead\"",
38028 "field": "moduleSearch",
38035 "field": "description",
38041 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38042 "version": "0.0.0",
38043 "filename": "server/api/intZohoConfiguration/index.js",
38044 "groupTitle": "Zoho_Configurations"
38048 "url": "/api/integrations/zoho/configurations/{id}",
38049 "title": "Deletes a Zoho Configuration",
38052 "title": "Example usage:",
38053 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
38057 "name": "DeleteZoho_Configurations",
38058 "group": "Zoho_Configurations",
38059 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38060 "version": "0.0.0",
38061 "filename": "server/api/intZohoConfiguration/index.js",
38062 "groupTitle": "Zoho_Configurations"
38066 "url": "/api/integrations/zoho/configurations",
38067 "title": "Gets a list of Zoho Configurations",
38070 "title": "Example usage:",
38071 "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
38075 "name": "GetZoho_Configurations",
38076 "group": "Zoho_Configurations",
38077 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38078 "version": "0.0.0",
38079 "filename": "server/api/intZohoConfiguration/index.js",
38080 "groupTitle": "Zoho_Configurations"
38084 "url": "/api/integrations/zoho/configurations/{id}",
38085 "title": "Gets a single Zoho Configuration",
38088 "title": "Example usage:",
38089 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
38093 "name": "ShowZoho_Configurations",
38094 "group": "Zoho_Configurations",
38095 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38096 "version": "0.0.0",
38097 "filename": "server/api/intZohoConfiguration/index.js",
38098 "groupTitle": "Zoho_Configurations"
38102 "url": "/api/integrations/zoho/configurations/{id}/descriptions",
38103 "title": "Gets configurations descriptions",
38106 "title": "Example usage:",
38107 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
38111 "name": "getDescriptions",
38112 "group": "Zoho_Configurations",
38113 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38114 "version": "0.0.0",
38115 "filename": "server/api/intZohoConfiguration/index.js",
38116 "groupTitle": "Zoho_Configurations"
38120 "url": "/api/integrations/zoho/configurations/{id}/fields",
38121 "title": "Gets configurations fields",
38124 "title": "Example usage:",
38125 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
38129 "name": "getFields",
38130 "group": "Zoho_Configurations",
38131 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38132 "version": "0.0.0",
38133 "filename": "server/api/intZohoConfiguration/index.js",
38134 "groupTitle": "Zoho_Configurations"
38138 "url": "/api/integrations/zoho/configurations/{id}/subjects",
38139 "title": "Gets configurations subjects",
38142 "title": "Example usage:",
38143 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
38147 "name": "getSubjects",
38148 "group": "Zoho_Configurations",
38149 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38150 "version": "0.0.0",
38151 "filename": "server/api/intZohoConfiguration/index.js",
38152 "groupTitle": "Zoho_Configurations"
38156 "url": "/api/integrations/zoho/configurations/{id}",
38157 "title": "Update an existing Zoho Configuration",
38160 "title": "Example usage:",
38161 "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",
38165 "name": "updateZoho_Configurations",
38166 "group": "Zoho_Configurations",
38167 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38168 "version": "0.0.0",
38169 "filename": "server/api/intZohoConfiguration/index.js",
38170 "groupTitle": "Zoho_Configurations"
38174 "url": "/api/integrations/zoho/fields",
38175 "title": "Creates a new Zoho Field",
38178 "title": "Example usage:",
38179 "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",
38183 "name": "CreateZoho_Fields",
38184 "group": "Zoho_Fields",
38194 "\"customVariable\"",
38206 "field": "content",
38222 "\"customVariable\""
38225 "field": "keyType",
38232 "field": "keyContent",
38239 "field": "idField",
38246 "field": "nameField",
38253 "field": "customField",
38260 "field": "variableName",
38266 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38267 "version": "0.0.0",
38268 "filename": "server/api/intZohoField/index.js",
38269 "groupTitle": "Zoho_Fields"
38273 "url": "/api/integrations/zoho/fields/{id}",
38274 "title": "Deletes a Zoho Field",
38277 "title": "Example usage:",
38278 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
38282 "name": "DeleteZoho_Fields",
38283 "group": "Zoho_Fields",
38284 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38285 "version": "0.0.0",
38286 "filename": "server/api/intZohoField/index.js",
38287 "groupTitle": "Zoho_Fields"
38291 "url": "/api/integrations/zoho/fields",
38292 "title": "Gets a list of Zoho Fields",
38295 "title": "Example usage:",
38296 "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
38300 "name": "GetZoho_Fields",
38301 "group": "Zoho_Fields",
38302 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38303 "version": "0.0.0",
38304 "filename": "server/api/intZohoField/index.js",
38305 "groupTitle": "Zoho_Fields"
38309 "url": "/api/integrations/zoho/fields/{id}",
38310 "title": "Gets a single Zoho Field",
38313 "title": "Example usage:",
38314 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
38318 "name": "ShowZoho_Fields",
38319 "group": "Zoho_Fields",
38320 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38321 "version": "0.0.0",
38322 "filename": "server/api/intZohoField/index.js",
38323 "groupTitle": "Zoho_Fields"
38327 "url": "/api/integrations/zoho/fields/{id}",
38328 "title": "Update an existing Zoho Field",
38331 "title": "Example usage:",
38332 "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",
38336 "name": "updateZoho_Fields",
38337 "group": "Zoho_Fields",
38338 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38339 "version": "0.0.0",
38340 "filename": "server/api/intZohoField/index.js",
38341 "groupTitle": "Zoho_Fields"
38346 "title": "Creates a new Cdr",
38349 "title": "Example usage:",
38350 "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38354 "name": "CreateCdrs",
38363 "field": "calldate",
38391 "field": "dcontext",
38398 "field": "channel",
38405 "field": "dstchannel",
38412 "field": "lastapp",
38419 "field": "lastdata",
38426 "field": "duration",
38433 "field": "billsec",
38440 "field": "disposition",
38447 "field": "amaflags",
38454 "field": "accountcode",
38461 "field": "userfield",
38468 "field": "uniqueid",
38475 "field": "linkedid",
38482 "field": "sequence",
38489 "field": "peeraccount",
38509 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38510 "version": "0.0.0",
38511 "filename": "server/api/cdr/index.js",
38512 "groupTitle": "cdr"
38516 "url": "/api/cdr/{id}",
38517 "title": "Deletes a Cdr",
38520 "title": "Example usage:",
38521 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
38525 "name": "DeleteCdrs",
38527 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38528 "version": "0.0.0",
38529 "filename": "server/api/cdr/index.js",
38530 "groupTitle": "cdr"
38534 "url": "/api/cdr/describe",
38535 "title": "Gets table info about Cdrs",
38538 "title": "Example usage:",
38539 "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
38543 "name": "DescribeCdrs",
38545 "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>",
38546 "version": "0.0.0",
38547 "filename": "server/api/cdr/index.js",
38548 "groupTitle": "cdr"
38553 "title": "Gets a list of Cdrs",
38556 "title": "Example usage:",
38557 "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
38563 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38564 "version": "0.0.0",
38565 "filename": "server/api/cdr/index.js",
38566 "groupTitle": "cdr"
38570 "url": "/api/cdr/{id}",
38571 "title": "Gets a single Cdr",
38574 "title": "Example usage:",
38575 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
38579 "name": "ShowCdrs",
38581 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38582 "version": "0.0.0",
38583 "filename": "server/api/cdr/index.js",
38584 "groupTitle": "cdr"
38588 "url": "/api/cdr/{id}",
38589 "title": "Update an existing Cdr",
38592 "title": "Example usage:",
38593 "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38597 "name": "updateCdrs",
38599 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38600 "version": "0.0.0",
38601 "filename": "server/api/cdr/index.js",
38602 "groupTitle": "cdr"
38606 "url": "/api/voiceQueuesLog",
38607 "title": "Creates a new VoiceQueuesLog",
38610 "title": "Example usage:",
38611 "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38615 "name": "CreateVoiceQueuesLogs",
38616 "group": "voiceQueuesLog",
38638 "field": "queuename",
38707 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38708 "version": "0.0.0",
38709 "filename": "server/api/voiceQueuesLog/index.js",
38710 "groupTitle": "voiceQueuesLog"
38714 "url": "/api/voiceQueuesLog/{id}",
38715 "title": "Deletes a VoiceQueuesLog",
38718 "title": "Example usage:",
38719 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
38723 "name": "DeleteVoiceQueuesLogs",
38724 "group": "voiceQueuesLog",
38725 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38726 "version": "0.0.0",
38727 "filename": "server/api/voiceQueuesLog/index.js",
38728 "groupTitle": "voiceQueuesLog"
38732 "url": "/api/voiceQueuesLog",
38733 "title": "Gets a list of VoiceQueuesLogs",
38736 "title": "Example usage:",
38737 "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
38741 "name": "GetVoiceQueuesLogs",
38742 "group": "voiceQueuesLog",
38743 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38744 "version": "0.0.0",
38745 "filename": "server/api/voiceQueuesLog/index.js",
38746 "groupTitle": "voiceQueuesLog"
38750 "url": "/api/voiceQueuesLog/{id}",
38751 "title": "Gets a single VoiceQueuesLog",
38754 "title": "Example usage:",
38755 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
38759 "name": "ShowVoiceQueuesLogs",
38760 "group": "voiceQueuesLog",
38761 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38762 "version": "0.0.0",
38763 "filename": "server/api/voiceQueuesLog/index.js",
38764 "groupTitle": "voiceQueuesLog"
38768 "url": "/api/voiceQueuesLog/{id}",
38769 "title": "Update an existing VoiceQueuesLog",
38772 "title": "Example usage:",
38773 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38777 "name": "updateVoiceQueuesLogs",
38778 "group": "voiceQueuesLog",
38779 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38780 "version": "0.0.0",
38781 "filename": "server/api/voiceQueuesLog/index.js",
38782 "groupTitle": "voiceQueuesLog"