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/google",
1373 "title": "Creates a new User token",
1376 "title": "Example usage:",
1377 "content": "curl https://{domain}/api/auth/google -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/authGoogle/index.js",
1406 "groupTitle": "Authentication"
1410 "url": "/api/auth/activedirectory",
1411 "title": "Creates a new User token",
1414 "title": "Example usage:",
1415 "content": "curl https://{domain}/api/auth/activedirectory -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/authActiveDirectory/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": "alignment",
4383 "field": "verticalAlignment",
4390 "field": "labelText",
4397 "field": "messagesAlignment",
4404 "field": "defaultTitle",
4411 "field": "customerAvatar",
4418 "field": "showCustomerAvatar",
4425 "field": "messageFontSize",
4432 "field": "backgroundColor",
4439 "field": "queueTransfer",
4446 "field": "queueTransferTimeout",
4453 "field": "agentTransfer",
4460 "field": "agentTransferTimeout",
4467 "field": "systemAlias",
4474 "field": "systemAvatar",
4481 "field": "mandatoryDispositionPauseId",
4482 "description": "<p>Status to put when mandatory disposition is enabled</p>"
4488 "field": "mandatoryDisposition",
4489 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4495 "field": "vidaooEscalation",
4502 "field": "vidaooApiKey",
4509 "field": "vidaooTopic",
4516 "field": "vidaooNote",
4523 "field": "vidaooMetadata",
4530 "field": "openNewInteraction",
4537 "field": "subjectOffline",
4543 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4545 "filename": "server/api/chatWebsite/index.js",
4546 "groupTitle": "Chat_Websites"
4550 "url": "/api/chat/websites/{id}",
4551 "title": "Deletes a Website",
4554 "title": "Example usage:",
4555 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4559 "name": "DeleteWebsites",
4560 "group": "Chat_Websites",
4561 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4563 "filename": "server/api/chatWebsite/index.js",
4564 "groupTitle": "Chat_Websites"
4568 "url": "/api/chat/websites/describe",
4569 "title": "Gets table info about Websites",
4572 "title": "Example usage:",
4573 "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4577 "name": "DescribeWebsites",
4578 "group": "Chat_Websites",
4579 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4581 "filename": "server/api/chatWebsite/index.js",
4582 "groupTitle": "Chat_Websites"
4586 "url": "/api/chat/websites/{id}/users",
4587 "title": "Gets agents from website",
4590 "title": "Example usage:",
4591 "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4595 "name": "GetAgents",
4596 "group": "Chat_Websites",
4597 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4599 "filename": "server/api/chatWebsite/index.js",
4600 "groupTitle": "Chat_Websites"
4604 "url": "/api/chat/websites",
4605 "title": "Gets a list of Websites",
4608 "title": "Example usage:",
4609 "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4613 "name": "GetWebsites",
4614 "group": "Chat_Websites",
4615 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
4617 "filename": "server/api/chatWebsite/index.js",
4618 "groupTitle": "Chat_Websites"
4622 "url": "/api/chat/websites/{id}/users",
4623 "title": "Removes agents from a website",
4626 "title": "Example usage:",
4627 "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4631 "name": "RemoveAgents",
4632 "group": "Chat_Websites",
4633 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4635 "filename": "server/api/chatWebsite/index.js",
4636 "groupTitle": "Chat_Websites"
4640 "url": "/api/chat/websites/{id}/canned_answers",
4641 "title": "Removes canned answers from account",
4644 "title": "Example usage:",
4645 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4649 "name": "RemoveAnswers",
4650 "group": "Chat_Websites",
4651 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4653 "filename": "server/api/chatWebsite/index.js",
4654 "groupTitle": "Chat_Websites"
4658 "url": "/api/chat/websites/{id}/dispositions",
4659 "title": "Removes canned answers from account",
4662 "title": "Example usage:",
4663 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4667 "name": "RemoveDispositions",
4668 "group": "Chat_Websites",
4669 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4671 "filename": "server/api/chatWebsite/index.js",
4672 "groupTitle": "Chat_Websites"
4676 "url": "/api/chat/websites/{id}",
4677 "title": "Gets a single Website",
4680 "title": "Example usage:",
4681 "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4685 "name": "ShowWebsites",
4686 "group": "Chat_Websites",
4687 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4689 "filename": "server/api/chatWebsite/index.js",
4690 "groupTitle": "Chat_Websites"
4694 "url": "/api/chat/messages/{id}/accept",
4695 "title": "Accepts message",
4698 "title": "Example usage:",
4699 "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4703 "name": "acceptMessage",
4704 "group": "Chat_Websites",
4705 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4707 "filename": "server/api/chatMessage/index.js",
4708 "groupTitle": "Chat_Websites"
4712 "url": "/api/chat/websites/{id}/canned_answers",
4713 "title": "Creates new canned answer",
4716 "title": "Example usage:",
4717 "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",
4721 "name": "addAnswer",
4722 "group": "Chat_Websites",
4744 "field": "description",
4757 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4759 "filename": "server/api/chatWebsite/index.js",
4760 "groupTitle": "Chat_Websites"
4764 "url": "/api/chat/websites/{id}/applications",
4765 "title": "Creates new applications",
4768 "title": "Example usage:",
4769 "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4773 "name": "addApplications",
4774 "group": "Chat_Websites",
4782 "field": "priority",
4803 "field": "description",
4810 "field": "interval",
4816 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4818 "filename": "server/api/chatWebsite/index.js",
4819 "groupTitle": "Chat_Websites"
4823 "url": "/api/chat/websites/{id}/avatar",
4824 "title": "Add avatar",
4827 "title": "Example usage:",
4828 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4832 "name": "addAvatar",
4833 "group": "Chat_Websites",
4834 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4836 "filename": "server/api/chatWebsite/index.js",
4837 "groupTitle": "Chat_Websites"
4841 "url": "/api/chat/websites/{id}/customer_avatar",
4842 "title": "Add customer avatar",
4845 "title": "Example usage:",
4846 "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",
4850 "name": "addCustomerAvatar",
4851 "group": "Chat_Websites",
4852 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4854 "filename": "server/api/chatWebsite/index.js",
4855 "groupTitle": "Chat_Websites"
4859 "url": "/api/chat/websites/{id}/dispositions",
4860 "title": "Creates new disposition",
4863 "title": "Example usage:",
4864 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4868 "name": "addDisposition",
4869 "group": "Chat_Websites",
4896 "field": "description",
4902 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4904 "filename": "server/api/chatWebsite/index.js",
4905 "groupTitle": "Chat_Websites"
4909 "url": "/api/chat/accounts/{id}/interactions",
4910 "title": "Creates new interactions",
4913 "title": "Example usage:",
4914 "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",
4918 "name": "addInteraction",
4919 "group": "Chat_Websites",
4934 "field": "ratingValue",
4945 "field": "ratingType",
4952 "field": "ratingMessage",
4959 "field": "pathTranscript",
4966 "field": "mailTranscript",
4973 "field": "closedAt",
4980 "field": "disposition",
4987 "field": "secondDisposition",
4994 "field": "thirdDisposition",
5008 "field": "browserName",
5015 "field": "browserVersion",
5029 "field": "osVersion",
5036 "field": "deviceModel",
5043 "field": "deviceVendor",
5050 "field": "deviceType",
5064 "field": "customerIp",
5071 "field": "formData",
5078 "field": "read1stAt",
5085 "field": "lastMsgAt",
5096 "field": "lastMsgDirection",
5103 "field": "closeReason",
5110 "field": "customerPort",
5117 "field": "vidaooSessionId",
5124 "field": "autoreplyExecuted",
5130 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5132 "filename": "server/api/chatWebsite/index.js",
5133 "groupTitle": "Chat_Websites"
5137 "url": "/api/chat/websites/{id}/logo",
5138 "title": "Add logo",
5141 "title": "Example usage:",
5142 "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
5147 "group": "Chat_Websites",
5148 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5150 "filename": "server/api/chatWebsite/index.js",
5151 "groupTitle": "Chat_Websites"
5155 "url": "/api/chat/websites/{id}/proactive_actions",
5156 "title": "Creates new Proactive Actions",
5159 "title": "Example usage:",
5160 "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",
5164 "name": "addProactiveActions",
5165 "group": "Chat_Websites",
5191 "field": "selector",
5204 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5206 "filename": "server/api/chatWebsite/index.js",
5207 "groupTitle": "Chat_Websites"
5211 "url": "/api/chat/websites/{id}/system_avatar",
5212 "title": "Add system avatar",
5215 "title": "Example usage:",
5216 "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",
5220 "name": "addSystemAvatar",
5221 "group": "Chat_Websites",
5222 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5224 "filename": "server/api/chatWebsite/index.js",
5225 "groupTitle": "Chat_Websites"
5229 "url": "/api/chat/websites/{id}/canned_answers",
5230 "title": "Gets account canned answers",
5233 "title": "Example usage:",
5234 "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5238 "name": "getAnswers",
5239 "group": "Chat_Websites",
5240 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5242 "filename": "server/api/chatWebsite/index.js",
5243 "groupTitle": "Chat_Websites"
5247 "url": "/api/chat/websites/{id}/applications",
5248 "title": "Gets Website Applications",
5251 "title": "Example usage:",
5252 "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5256 "name": "getApplications",
5257 "group": "Chat_Websites",
5258 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5260 "filename": "server/api/chatWebsite/index.js",
5261 "groupTitle": "Chat_Websites"
5265 "url": "/api/chat/websites/{id}/avatar",
5266 "title": "Get avatar",
5269 "title": "Example usage:",
5270 "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5274 "name": "getAvatar",
5275 "group": "Chat_Websites",
5276 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5278 "filename": "server/api/chatWebsite/index.js",
5279 "groupTitle": "Chat_Websites"
5283 "url": "/api/chat/websites/{id}/customer_avatar",
5284 "title": "Get Customer Avatar",
5287 "title": "Example usage:",
5288 "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5292 "name": "getCustomerAvatar",
5293 "group": "Chat_Websites",
5294 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5296 "filename": "server/api/chatWebsite/index.js",
5297 "groupTitle": "Chat_Websites"
5301 "url": "/api/chat/websites/{id}/dispositions",
5302 "title": "Gets account dispositions",
5305 "title": "Example usage:",
5306 "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5310 "name": "getDispositions",
5311 "group": "Chat_Websites",
5312 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5314 "filename": "server/api/chatWebsite/index.js",
5315 "groupTitle": "Chat_Websites"
5319 "url": "/api/chat/websites/{id}/fields",
5320 "title": "Gets Website Fields",
5323 "title": "Example usage:",
5324 "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5328 "name": "getFields",
5329 "group": "Chat_Websites",
5330 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5332 "filename": "server/api/chatWebsite/index.js",
5333 "groupTitle": "Chat_Websites"
5337 "url": "/api/chat/websites/{id}/interactions",
5338 "title": "Gets Website Interactions",
5341 "title": "Example usage:",
5342 "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5346 "name": "getInteraction",
5347 "group": "Chat_Websites",
5348 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5350 "filename": "server/api/chatWebsite/index.js",
5351 "groupTitle": "Chat_Websites"
5355 "url": "/api/chat/websites/{id}/logo",
5356 "title": "Get logo",
5359 "title": "Example usage:",
5360 "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5365 "group": "Chat_Websites",
5366 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5368 "filename": "server/api/chatWebsite/index.js",
5369 "groupTitle": "Chat_Websites"
5373 "url": "/api/chat/websites/{id}/offline_messages",
5374 "title": "Gets Website Offline Messages",
5377 "title": "Example usage:",
5378 "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5382 "name": "getOfflineMessages",
5383 "group": "Chat_Websites",
5384 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5386 "filename": "server/api/chatWebsite/index.js",
5387 "groupTitle": "Chat_Websites"
5391 "url": "/api/chat/websites/{id}/proactive_actions",
5392 "title": "Gets Website Proactive Actions",
5395 "title": "Example usage:",
5396 "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5400 "name": "getProactiveActions",
5401 "group": "Chat_Websites",
5402 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5404 "filename": "server/api/chatWebsite/index.js",
5405 "groupTitle": "Chat_Websites"
5409 "url": "/api/chat/websites/{id}/snippet",
5410 "title": "Gets Website Snippet",
5413 "title": "Example usage:",
5414 "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5418 "name": "getSnippet",
5419 "group": "Chat_Websites",
5420 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5422 "filename": "server/api/chatWebsite/index.js",
5423 "groupTitle": "Chat_Websites"
5427 "url": "/api/chat/websites/{id}/system_avatar",
5428 "title": "Get System Avatar",
5431 "title": "Example usage:",
5432 "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5436 "name": "getSystemAvatar",
5437 "group": "Chat_Websites",
5438 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5440 "filename": "server/api/chatWebsite/index.js",
5441 "groupTitle": "Chat_Websites"
5445 "url": "/api/chat/websites/{id}/notify",
5446 "title": "Notify new message",
5449 "title": "Example usage:",
5450 "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",
5455 "group": "Chat_Websites",
5456 "description": "<p>Motion 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>",
5458 "filename": "server/api/chatWebsite/index.js",
5459 "groupTitle": "Chat_Websites"
5463 "url": "/api/chat/websites/{id}/offline",
5464 "title": "Offline message",
5467 "title": "Example usage:",
5468 "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",
5473 "group": "Chat_Websites",
5474 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5476 "filename": "server/api/chatWebsite/index.js",
5477 "groupTitle": "Chat_Websites"
5481 "url": "/api/chat/messages/{id}/reject",
5482 "title": "Rejects message",
5485 "title": "Example usage:",
5486 "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5490 "name": "rejectMessage",
5491 "group": "Chat_Websites",
5492 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5494 "filename": "server/api/chatMessage/index.js",
5495 "groupTitle": "Chat_Websites"
5499 "url": "/api/chat/websites/{id}",
5500 "title": "Update an existing Website",
5503 "title": "Example usage:",
5504 "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",
5508 "name": "updateWebsites",
5509 "group": "Chat_Websites",
5510 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5512 "filename": "server/api/chatWebsite/index.js",
5513 "groupTitle": "Chat_Websites"
5517 "url": "/api/cloudProviders",
5518 "title": "Creates a new CloudProvider",
5521 "title": "Example usage:",
5522 "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5526 "name": "CreateCloudProviders",
5527 "group": "CloudProviders",
5566 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5568 "filename": "server/api/cloudProvider/index.js",
5569 "groupTitle": "CloudProviders"
5573 "url": "/api/cloudProviders/{id}",
5574 "title": "Deletes a CloudProvider",
5577 "title": "Example usage:",
5578 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5582 "name": "DeleteCloudProviders",
5583 "group": "CloudProviders",
5584 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5586 "filename": "server/api/cloudProvider/index.js",
5587 "groupTitle": "CloudProviders"
5591 "url": "/api/cloudProviders",
5592 "title": "Gets a list of CloudProviders",
5595 "title": "Example usage:",
5596 "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5600 "name": "GetCloudProviders",
5601 "group": "CloudProviders",
5602 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5604 "filename": "server/api/cloudProvider/index.js",
5605 "groupTitle": "CloudProviders"
5609 "url": "/api/cloudProviders/oauth2/microsoft/authorize/{id}",
5610 "title": "Generates the Microsoft Identity platform authorization url",
5613 "title": "Example usage:",
5614 "content": "curl https://{domain}/api/cloudProviders/oauth2/microsoft/authorize/{id} -v -u {name}:{password}",
5618 "name": "Oauth2MicrosoftAuthorize",
5619 "group": "CloudProviders",
5620 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5622 "filename": "server/api/cloudProvider/index.js",
5623 "groupTitle": "CloudProviders"
5627 "url": "/api/cloudProviders/oauth2/microsoft/callback",
5628 "title": "Receives an authorization code from Microsoft Identity platform",
5629 "name": "Oauth2MicrosoftCallback",
5630 "group": "CloudProviders",
5631 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5633 "filename": "server/api/cloudProvider/index.js",
5634 "groupTitle": "CloudProviders"
5638 "url": "/api/cloudProviders/{id}",
5639 "title": "Gets a single CloudProvider",
5642 "title": "Example usage:",
5643 "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5647 "name": "ShowCloudProviders",
5648 "group": "CloudProviders",
5649 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5651 "filename": "server/api/cloudProvider/index.js",
5652 "groupTitle": "CloudProviders"
5656 "url": "/api/cloudProviders/{id}",
5657 "title": "Update an existing CloudProvider",
5660 "title": "Example usage:",
5661 "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5665 "name": "updateCloudProviders",
5666 "group": "CloudProviders",
5667 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5669 "filename": "server/api/cloudProvider/index.js",
5670 "groupTitle": "CloudProviders"
5674 "url": "/api/cm_contact_has_items",
5675 "title": "Creates a new CmContactHasItem",
5678 "title": "Example usage:",
5679 "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",
5683 "name": "CreateCmContactHasItems",
5684 "group": "CmContactHasItems",
5692 "field": "CmContactId",
5706 "field": "ItemTypeId",
5713 "field": "ItemClass",
5727 "field": "description",
5733 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5735 "filename": "server/api/cmContactHasItem/index.js",
5736 "groupTitle": "CmContactHasItems"
5740 "url": "/api/cm_contact_has_items/{id}",
5741 "title": "Deletes a CmContactHasItem",
5744 "title": "Example usage:",
5745 "content": "curl https://{domain}/api/cm_contact_has_items/{id} -v -u {name}:{password} -X DELETE",
5749 "name": "DeleteCmContactHasItems",
5750 "group": "CmContactHasItems",
5751 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5753 "filename": "server/api/cmContactHasItem/index.js",
5754 "groupTitle": "CmContactHasItems"
5758 "url": "/api/cm_contact_has_items",
5759 "title": "Gets a list of CmContactHasItems",
5762 "title": "Example usage:",
5763 "content": "curl https://{domain}/api/cm_contact_has_items -v -u {name}:{password}",
5767 "name": "GetCmContactHasItems",
5768 "group": "CmContactHasItems",
5769 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5771 "filename": "server/api/cmContactHasItem/index.js",
5772 "groupTitle": "CmContactHasItems"
5776 "url": "/api/cm_contact_has_items/{id}",
5777 "title": "Gets a single CmContactHasItem",
5780 "title": "Example usage:",
5781 "content": "curl https://{domain}/api/cm_contact_has_items/{id} -v -u {name}:{password}",
5785 "name": "ShowCmContactHasItems",
5786 "group": "CmContactHasItems",
5787 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5789 "filename": "server/api/cmContactHasItem/index.js",
5790 "groupTitle": "CmContactHasItems"
5794 "url": "/api/cm_contact_has_items/{id}",
5795 "title": "Update an existing CmContactHasItem",
5798 "title": "Example usage:",
5799 "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",
5803 "name": "updateCmContactHasItems",
5804 "group": "CmContactHasItems",
5805 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5807 "filename": "server/api/cmContactHasItem/index.js",
5808 "groupTitle": "CmContactHasItems"
5812 "url": "/api/cm_hopper_additional_phones",
5813 "title": "Creates a new CmHopperAdditionalPhone",
5816 "title": "Example usage:",
5817 "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",
5821 "name": "CreateCmHopperAdditionalPhones",
5822 "group": "CmHopperAdditionalPhones",
5830 "field": "CmHopperId",
5851 "field": "scheduledat",
5858 "field": "countbusyretry",
5865 "field": "countcongestionretry",
5872 "field": "countnoanswerretry",
5879 "field": "countnosuchnumberretry",
5886 "field": "countdropretry",
5893 "field": "countabandonedretry",
5900 "field": "countmachineretry",
5907 "field": "countagentrejectretry",
5913 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5915 "filename": "server/api/cmHopperAdditionalPhone/index.js",
5916 "groupTitle": "CmHopperAdditionalPhones"
5920 "url": "/api/cm_hopper_additional_phones/{id}",
5921 "title": "Deletes a CmHopperAdditionalPhone",
5924 "title": "Example usage:",
5925 "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -v -u {name}:{password} -X DELETE",
5929 "name": "DeleteCmHopperAdditionalPhones",
5930 "group": "CmHopperAdditionalPhones",
5931 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5933 "filename": "server/api/cmHopperAdditionalPhone/index.js",
5934 "groupTitle": "CmHopperAdditionalPhones"
5938 "url": "/api/cm_hopper_additional_phones",
5939 "title": "Gets a list of CmHopperAdditionalPhones",
5942 "title": "Example usage:",
5943 "content": "curl https://{domain}/api/cm_hopper_additional_phones -v -u {name}:{password}",
5947 "name": "GetCmHopperAdditionalPhones",
5948 "group": "CmHopperAdditionalPhones",
5949 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5951 "filename": "server/api/cmHopperAdditionalPhone/index.js",
5952 "groupTitle": "CmHopperAdditionalPhones"
5956 "url": "/api/cm_hopper_additional_phones/{id}",
5957 "title": "Gets a single CmHopperAdditionalPhone",
5960 "title": "Example usage:",
5961 "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -v -u {name}:{password}",
5965 "name": "ShowCmHopperAdditionalPhones",
5966 "group": "CmHopperAdditionalPhones",
5967 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5969 "filename": "server/api/cmHopperAdditionalPhone/index.js",
5970 "groupTitle": "CmHopperAdditionalPhones"
5974 "url": "/api/cm_hopper_additional_phones/{id}",
5975 "title": "Update an existing CmHopperAdditionalPhone",
5978 "title": "Example usage:",
5979 "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",
5983 "name": "updateCmHopperAdditionalPhones",
5984 "group": "CmHopperAdditionalPhones",
5985 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5987 "filename": "server/api/cmHopperAdditionalPhone/index.js",
5988 "groupTitle": "CmHopperAdditionalPhones"
5992 "url": "/api/cm/companies",
5993 "title": "Creates a new Company",
5996 "title": "Example usage:",
5997 "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6001 "name": "CreateCompanies",
6002 "group": "Cm_Companies",
6024 "field": "companyId",
6066 "field": "postalCode",
6094 "field": "emailDomain",
6108 "field": "sPostalCode",
6122 "field": "sCountry",
6129 "field": "description",
6135 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6137 "filename": "server/api/cmCompany/index.js",
6138 "groupTitle": "Cm_Companies"
6142 "url": "/api/cm/companies/{id}",
6143 "title": "Deletes a Company",
6146 "title": "Example usage:",
6147 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
6151 "name": "DeleteCompanies",
6152 "group": "Cm_Companies",
6153 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6155 "filename": "server/api/cmCompany/index.js",
6156 "groupTitle": "Cm_Companies"
6160 "url": "/api/cm/companies/describe",
6161 "title": "Gets table info about Companies",
6164 "title": "Example usage:",
6165 "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
6169 "name": "DescribeCompanies",
6170 "group": "Cm_Companies",
6171 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6173 "filename": "server/api/cmCompany/index.js",
6174 "groupTitle": "Cm_Companies"
6178 "url": "/api/cm/companies",
6179 "title": "Gets a list of Companies",
6182 "title": "Example usage:",
6183 "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
6187 "name": "GetCompanies",
6188 "group": "Cm_Companies",
6189 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6191 "filename": "server/api/cmCompany/index.js",
6192 "groupTitle": "Cm_Companies"
6196 "url": "/api/cm/companies/{id}",
6197 "title": "Gets a single Company",
6200 "title": "Example usage:",
6201 "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
6205 "name": "ShowCompanies",
6206 "group": "Cm_Companies",
6207 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6209 "filename": "server/api/cmCompany/index.js",
6210 "groupTitle": "Cm_Companies"
6214 "url": "/api/cm/companies/{id}/contacts",
6215 "title": "Creates new contacts",
6218 "title": "Example usage:",
6219 "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",
6223 "name": "addContacts",
6224 "group": "Cm_Companies",
6232 "field": "firstName",
6239 "field": "lastName",
6253 "field": "postalCode",
6274 "field": "dateOfBirth",
6281 "field": "description",
6323 "field": "facebook",
6379 "field": "telegram",
6393 "field": "priority",
6400 "field": "scheduledat",
6406 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6408 "filename": "server/api/cmCompany/index.js",
6409 "groupTitle": "Cm_Companies"
6413 "url": "/api/cm/companies/{id}/contacts",
6414 "title": "Gets List Contacts",
6417 "title": "Example usage:",
6418 "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
6422 "name": "getContacts",
6423 "group": "Cm_Companies",
6424 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6426 "filename": "server/api/cmCompany/index.js",
6427 "groupTitle": "Cm_Companies"
6431 "url": "/api/cm/companies/{id}",
6432 "title": "Update an existing Company",
6435 "title": "Example usage:",
6436 "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",
6440 "name": "updateCompanies",
6441 "group": "Cm_Companies",
6442 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6444 "filename": "server/api/cmCompany/index.js",
6445 "groupTitle": "Cm_Companies"
6449 "url": "/api/cm/contacts/{id}",
6450 "title": "Deletes a Contact",
6453 "title": "Example usage:",
6454 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
6458 "name": "DeleteContacts",
6459 "group": "Cm_Contacts",
6460 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6462 "filename": "server/api/cmContact/index.js",
6463 "groupTitle": "Cm_Contacts"
6467 "url": "/api/cm/contacts/describe",
6468 "title": "Gets table info about Contacts",
6471 "title": "Example usage:",
6472 "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
6476 "name": "DescribeContacts",
6477 "group": "Cm_Contacts",
6478 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6480 "filename": "server/api/cmContact/index.js",
6481 "groupTitle": "Cm_Contacts"
6485 "url": "/api/cm/contacts",
6486 "title": "Gets a list of Contacts",
6489 "title": "Example usage:",
6490 "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
6494 "name": "GetContacts",
6495 "group": "Cm_Contacts",
6496 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6498 "filename": "server/api/cmContact/index.js",
6499 "groupTitle": "Cm_Contacts"
6503 "url": "/api/cm/contacts/{id}/finals",
6504 "title": "Gets contact hopper finals",
6507 "title": "Example usage:",
6508 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password} -X GET",
6512 "name": "GetHopperFinals",
6513 "group": "Cm_Contacts",
6514 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6516 "filename": "server/api/cmContact/index.js",
6517 "groupTitle": "Cm_Contacts"
6521 "url": "/api/cm/contacts/{id}/hopper_histories",
6522 "title": "Gets contact hopper histories",
6525 "title": "Example usage:",
6526 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6530 "name": "GetHopperHistories",
6531 "group": "Cm_Contacts",
6532 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6534 "filename": "server/api/cmContact/index.js",
6535 "groupTitle": "Cm_Contacts"
6539 "url": "/api/cm/contacts/{id}/hoppers",
6540 "title": "Gets contact hoppers",
6543 "title": "Example usage:",
6544 "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6548 "name": "GetHoppers",
6549 "group": "Cm_Contacts",
6550 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6552 "filename": "server/api/cmContact/index.js",
6553 "groupTitle": "Cm_Contacts"
6557 "url": "/api/cm/contacts/create_many",
6558 "title": "Create Contacts",
6561 "title": "Example usage:",
6562 "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6566 "name": "bulkCreate",
6567 "group": "Cm_Contacts",
6568 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6570 "filename": "server/api/cmContact/index.js",
6571 "groupTitle": "Cm_Contacts"
6575 "url": "/api/cm/contacts",
6576 "title": "Create Contact",
6579 "title": "Example usage:",
6580 "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6585 "group": "Cm_Contacts",
6586 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6588 "filename": "server/api/cmContact/index.js",
6589 "groupTitle": "Cm_Contacts"
6593 "url": "/api/cm/contacts/{id}/duplicatePhones",
6594 "title": "Sets new contact additional phones",
6597 "title": "Example usage:",
6598 "content": "curl https://{domain}/api/cm/contacts/{id}/duplicateAdditionalPhones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6602 "name": "duplicateAdditionalPhones",
6603 "group": "Cm_Contacts",
6604 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6606 "filename": "server/api/cmContact/index.js",
6607 "groupTitle": "Cm_Contacts"
6611 "url": "/api/cm/contacts/{id}/phones",
6612 "title": "Gets contact phones",
6615 "title": "Example usage:",
6616 "content": "curl https://{domain}/api/cm/contacts/{id}/phones -v -u {name}:{password} -X GET",
6620 "name": "getAdditionalPhones",
6621 "group": "Cm_Contacts",
6622 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6624 "filename": "server/api/cmContact/index.js",
6625 "groupTitle": "Cm_Contacts"
6629 "url": "/api/cm/contacts/{id}/journey",
6630 "title": "Gets customer journey",
6633 "title": "Example usage:",
6634 "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password} -X GET",
6638 "name": "getJourney",
6639 "group": "Cm_Contacts",
6640 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6642 "filename": "server/api/cmContact/index.js",
6643 "groupTitle": "Cm_Contacts"
6647 "url": "/api/cm/contacts/{id}/jscripty_sessions",
6648 "title": "Gets contact hopper blacks",
6651 "title": "Example usage:",
6652 "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password} -X GET",
6656 "name": "getJscriptySessions",
6657 "group": "Cm_Contacts",
6658 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6660 "filename": "server/api/cmContact/index.js",
6661 "groupTitle": "Cm_Contacts"
6665 "url": "/api/cm/contacts/{id}/tags",
6666 "title": "Gets configurations tags",
6669 "title": "Example usage:",
6670 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6675 "group": "Cm_Contacts",
6676 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6678 "filename": "server/api/cmContact/index.js",
6679 "groupTitle": "Cm_Contacts"
6683 "url": "/api/cm/contacts/merge",
6684 "title": "Merge Contact",
6687 "title": "Example usage:",
6688 "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6693 "group": "Cm_Contacts",
6694 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6696 "filename": "server/api/cmContact/index.js",
6697 "groupTitle": "Cm_Contacts"
6701 "url": "/api/cm/contacts/{id}/rescheduleAdditionalPhones",
6702 "title": "Sets new contact additional phones",
6705 "title": "Example usage:",
6706 "content": "curl https://{domain}/api/cm/contacts/{id}/rescheduleAdditionalPhones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6710 "name": "rescheduleAdditionalPhones",
6711 "group": "Cm_Contacts",
6712 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6714 "filename": "server/api/cmContact/index.js",
6715 "groupTitle": "Cm_Contacts"
6719 "url": "/api/cm/contacts/{id}/phones",
6720 "title": "Sets new contact phones",
6723 "title": "Example usage:",
6724 "content": "curl https://{domain}/api/cm/contacts/{id}/phones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6728 "name": "setAdditionalPhones",
6729 "group": "Cm_Contacts",
6730 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6732 "filename": "server/api/cmContact/index.js",
6733 "groupTitle": "Cm_Contacts"
6737 "url": "/api/cm/contacts/{id}/tags",
6738 "title": "Sets new tags",
6741 "title": "Example usage:",
6742 "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6747 "group": "Cm_Contacts",
6748 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6750 "filename": "server/api/cmContact/index.js",
6751 "groupTitle": "Cm_Contacts"
6755 "url": "/api/cm/contacts/{id}",
6756 "title": "Gets a single Contact",
6759 "title": "Example usage:",
6760 "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6765 "group": "Cm_Contacts",
6766 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6768 "filename": "server/api/cmContact/index.js",
6769 "groupTitle": "Cm_Contacts"
6773 "url": "/api/cm/contacts/{id}",
6774 "title": "Update a single Contact",
6777 "title": "Example usage:",
6778 "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6783 "group": "Cm_Contacts",
6784 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6786 "filename": "server/api/cmContact/index.js",
6787 "groupTitle": "Cm_Contacts"
6791 "url": "/api/cm/custom_fields/{id}",
6792 "title": "Deletes a Custom Field",
6795 "title": "Example usage:",
6796 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6800 "name": "DeleteCustom_Fields",
6801 "group": "Cm_Custom_Fields",
6802 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6804 "filename": "server/api/cmCustomField/index.js",
6805 "groupTitle": "Cm_Custom_Fields"
6809 "url": "/api/cm/custom_fields",
6810 "title": "Gets a list of Custom Fields",
6813 "title": "Example usage:",
6814 "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6818 "name": "GetCustom_Fields",
6819 "group": "Cm_Custom_Fields",
6820 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6822 "filename": "server/api/cmCustomField/index.js",
6823 "groupTitle": "Cm_Custom_Fields"
6827 "url": "/api/cm/custom_fields/{id}",
6828 "title": "Gets a single Custom Field",
6831 "title": "Example usage:",
6832 "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6836 "name": "ShowCustom_Fields",
6837 "group": "Cm_Custom_Fields",
6838 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6840 "filename": "server/api/cmCustomField/index.js",
6841 "groupTitle": "Cm_Custom_Fields"
6845 "url": "/api/cm/custom_fields/{id}",
6846 "title": "Update an existing Custom Field",
6849 "title": "Example usage:",
6850 "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",
6854 "name": "updateCustom_Fields",
6855 "group": "Cm_Custom_Fields",
6856 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6858 "filename": "server/api/cmCustomField/index.js",
6859 "groupTitle": "Cm_Custom_Fields"
6863 "url": "/api/cm/hopper",
6864 "title": "Creates a new Hopper",
6867 "title": "Example usage:",
6868 "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6872 "name": "CreateHopper",
6873 "group": "Cm_Hopper",
6895 "field": "scheduledat",
6902 "field": "countbusyretry",
6909 "field": "countcongestionretry",
6916 "field": "countnoanswerretry",
6923 "field": "callback",
6930 "field": "callbackuniqueid",
6937 "field": "callbackat",
6944 "field": "priority",
6951 "field": "recallme",
6958 "field": "ContactId",
6979 "field": "VoiceQueueId",
6986 "field": "CampaignId",
6993 "field": "countnosuchnumberretry",
7000 "field": "countdropretry",
7007 "field": "countabandonedretry",
7014 "field": "countmachineretry",
7021 "field": "countagentrejectretry",
7035 "field": "dialTimezone",
7041 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7043 "filename": "server/api/cmHopper/index.js",
7044 "groupTitle": "Cm_Hopper"
7048 "url": "/api/cm/hopper/describe",
7049 "title": "Gets table info about Hopper",
7052 "title": "Example usage:",
7053 "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
7057 "name": "DescribeHopper",
7058 "group": "Cm_Hopper",
7059 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7061 "filename": "server/api/cmHopper/index.js",
7062 "groupTitle": "Cm_Hopper"
7066 "url": "/api/cm/hopper",
7067 "title": "Gets a list of Hopper",
7070 "title": "Example usage:",
7071 "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
7075 "name": "GetHopper",
7076 "group": "Cm_Hopper",
7077 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7079 "filename": "server/api/cmHopper/index.js",
7080 "groupTitle": "Cm_Hopper"
7084 "url": "/api/cm/hopper/{id}",
7085 "title": "Gets a single Hopper",
7088 "title": "Example usage:",
7089 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
7093 "name": "ShowHopper",
7094 "group": "Cm_Hopper",
7095 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7097 "filename": "server/api/cmHopper/index.js",
7098 "groupTitle": "Cm_Hopper"
7102 "url": "/api/cm/hopper_black/{id}",
7103 "title": "Deletes a Hopper Black",
7106 "title": "Example usage:",
7107 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
7111 "name": "DeleteHopper_Black",
7112 "group": "Cm_Hopper_Black",
7113 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7115 "filename": "server/api/cmHopperBlack/index.js",
7116 "groupTitle": "Cm_Hopper_Black"
7120 "url": "/api/cm/hopper_black/describe",
7121 "title": "Gets table info about Hopper Black",
7124 "title": "Example usage:",
7125 "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
7129 "name": "DescribeHopper_Black",
7130 "group": "Cm_Hopper_Black",
7131 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7133 "filename": "server/api/cmHopperBlack/index.js",
7134 "groupTitle": "Cm_Hopper_Black"
7138 "url": "/api/cm/hopper_black",
7139 "title": "Gets a list of Hopper Black",
7142 "title": "Example usage:",
7143 "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
7147 "name": "GetHopper_Black",
7148 "group": "Cm_Hopper_Black",
7149 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7151 "filename": "server/api/cmHopperBlack/index.js",
7152 "groupTitle": "Cm_Hopper_Black"
7156 "url": "/api/cm/hopper_black/{id}",
7157 "title": "Gets a single Hopper Black",
7160 "title": "Example usage:",
7161 "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
7165 "name": "ShowHopper_Black",
7166 "group": "Cm_Hopper_Black",
7167 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7169 "filename": "server/api/cmHopperBlack/index.js",
7170 "groupTitle": "Cm_Hopper_Black"
7174 "url": "/api/cm/hopper_black/{id}",
7175 "title": "Update an existing Hopper Black",
7178 "title": "Example usage:",
7179 "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",
7183 "name": "updateHopper_Black",
7184 "group": "Cm_Hopper_Black",
7185 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7187 "filename": "server/api/cmHopperBlack/index.js",
7188 "groupTitle": "Cm_Hopper_Black"
7192 "url": "/api/cm/hopper_final/checkContactHopper",
7193 "title": "Check if contact is in hopper",
7196 "title": "Example usage:",
7197 "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",
7201 "name": "/checkContactHopper",
7202 "group": "Cm_Hopper_Final",
7203 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7205 "filename": "server/api/cmHopperFinal/index.js",
7206 "groupTitle": "Cm_Hopper_Final"
7210 "url": "/api/cm/hopper_final/describe",
7211 "title": "Gets table info about HopperFinal",
7214 "title": "Example usage:",
7215 "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
7219 "name": "DescribeHopperFinal",
7220 "group": "Cm_Hopper_Final",
7221 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7223 "filename": "server/api/cmHopperFinal/index.js",
7224 "groupTitle": "Cm_Hopper_Final"
7228 "url": "/api/cm/hopper_final",
7229 "title": "Gets a list of HopperFinal",
7232 "title": "Example usage:",
7233 "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
7237 "name": "GetHopperFinal",
7238 "group": "Cm_Hopper_Final",
7239 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7241 "filename": "server/api/cmHopperFinal/index.js",
7242 "groupTitle": "Cm_Hopper_Final"
7246 "url": "/api/cm/hopper_final/{id}",
7247 "title": "Gets a single HopperFinal",
7250 "title": "Example usage:",
7251 "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
7255 "name": "ShowHopperFinal",
7256 "group": "Cm_Hopper_Final",
7257 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7259 "filename": "server/api/cmHopperFinal/index.js",
7260 "groupTitle": "Cm_Hopper_Final"
7264 "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
7265 "title": "Return number contacts for attributes",
7268 "title": "Example usage:",
7269 "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
7273 "name": "countContactsIvrCampaignHopperFinal",
7274 "group": "Cm_Hopper_Final",
7275 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7277 "filename": "server/api/cmHopperFinal/index.js",
7278 "groupTitle": "Cm_Hopper_Final"
7282 "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
7283 "title": "Return number contacts for attributes",
7286 "title": "Example usage:",
7287 "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
7291 "name": "countContactsQueueCampaignHopperFinal",
7292 "group": "Cm_Hopper_Final",
7293 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7295 "filename": "server/api/cmHopperFinal/index.js",
7296 "groupTitle": "Cm_Hopper_Final"
7300 "url": "/api/cm/hopper_final/campaign/{id}",
7301 "title": "Move contacts in hopper",
7304 "title": "Example usage:",
7305 "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7309 "name": "moveContactsIvrCampaignHopperFinal",
7310 "group": "Cm_Hopper_Final",
7311 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7313 "filename": "server/api/cmHopperFinal/index.js",
7314 "groupTitle": "Cm_Hopper_Final"
7318 "url": "/api/cm/hopper_final/voice/queue/{id}",
7319 "title": "Move contacts in hopper",
7322 "title": "Example usage:",
7323 "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
7327 "name": "moveContactsQueueCampaignHopperFinal",
7328 "group": "Cm_Hopper_Final",
7329 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7331 "filename": "server/api/cmHopperFinal/index.js",
7332 "groupTitle": "Cm_Hopper_Final"
7336 "url": "/api/cm/hopper_final/{id}",
7337 "title": "Update a single hopper final",
7340 "title": "Example usage:",
7341 "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7346 "group": "Cm_Hopper_Final",
7347 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7349 "filename": "server/api/cmHopperFinal/index.js",
7350 "groupTitle": "Cm_Hopper_Final"
7354 "url": "/api/cm/hopper_history",
7355 "title": "Creates a new HopperHistory",
7358 "title": "Example usage:",
7359 "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",
7363 "name": "CreateHopperHistory",
7364 "group": "Cm_Hopper_History",
7379 "field": "statedesc",
7386 "field": "scheduledat",
7393 "field": "countbusyretry",
7400 "field": "countcongestionretry",
7407 "field": "countnoanswerretry",
7414 "field": "countglobal",
7421 "field": "uniqueid",
7428 "field": "originatecalleridnum",
7435 "field": "originatecalleridname",
7442 "field": "calleridnum",
7449 "field": "calleridname",
7456 "field": "starttime",
7463 "field": "responsetime",
7470 "field": "answertime",
7477 "field": "droptime",
7491 "field": "ringtime",
7498 "field": "holdtime",
7505 "field": "talktime",
7512 "field": "followuptime",
7519 "field": "dropreason",
7526 "field": "campaign",
7533 "field": "campaigntype",
7540 "field": "membername",
7568 "field": "callback",
7575 "field": "callbackuniqueid",
7582 "field": "callbackat",
7589 "field": "recallme",
7596 "field": "editedat",
7610 "field": "countnosuchnumberretry",
7617 "field": "countdropretry",
7624 "field": "countabandonedretry",
7631 "field": "countmachineretry",
7638 "field": "countagentrejectretry",
7644 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7646 "filename": "server/api/cmHopperHistory/index.js",
7647 "groupTitle": "Cm_Hopper_History"
7651 "url": "/api/cm/hopper_history/describe",
7652 "title": "Gets table info about HopperHistory",
7655 "title": "Example usage:",
7656 "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7660 "name": "DescribeHopperHistory",
7661 "group": "Cm_Hopper_History",
7662 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7664 "filename": "server/api/cmHopperHistory/index.js",
7665 "groupTitle": "Cm_Hopper_History"
7669 "url": "/api/cm/hopper_history",
7670 "title": "Gets a list of HopperHistory",
7673 "title": "Example usage:",
7674 "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7678 "name": "GetHopperHistory",
7679 "group": "Cm_Hopper_History",
7680 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7682 "filename": "server/api/cmHopperHistory/index.js",
7683 "groupTitle": "Cm_Hopper_History"
7687 "url": "/api/cm/hopper_history/{id}",
7688 "title": "Gets a single HopperHistory",
7691 "title": "Example usage:",
7692 "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7696 "name": "ShowHopperHistory",
7697 "group": "Cm_Hopper_History",
7698 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7700 "filename": "server/api/cmHopperHistory/index.js",
7701 "groupTitle": "Cm_Hopper_History"
7705 "url": "/api/cm/hopper_history/{id}",
7706 "title": "Update a single hopper history",
7709 "title": "Example usage:",
7710 "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7715 "group": "Cm_Hopper_History",
7716 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7718 "filename": "server/api/cmHopperHistory/index.js",
7719 "groupTitle": "Cm_Hopper_History"
7723 "url": "/api/cm/hopper/{id}",
7724 "title": "Delete Hopper",
7727 "title": "Example usage:",
7728 "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7733 "group": "Cm_Hopper",
7734 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7736 "filename": "server/api/cmHopper/index.js",
7737 "groupTitle": "Cm_Hopper"
7741 "url": "/api/cm/hopper/opencontacts",
7742 "title": "Gets Open Contacts",
7745 "title": "Example usage:",
7746 "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7750 "name": "getOpenContacts",
7751 "group": "Cm_Hopper",
7752 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7754 "filename": "server/api/cmHopper/index.js",
7755 "groupTitle": "Cm_Hopper"
7759 "url": "/api/cm/hopper/preview",
7760 "title": "Gets Preview Dialer Contacts",
7763 "title": "Example usage:",
7764 "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7768 "name": "getPreview",
7769 "group": "Cm_Hopper",
7770 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7772 "filename": "server/api/cmHopper/index.js",
7773 "groupTitle": "Cm_Hopper"
7777 "url": "/api/cm/hopper/{id}/previewrecall",
7778 "title": "Gets Preview Dialer Contacts for Recall",
7781 "title": "Example usage:",
7782 "content": "curl https://{domain}/api/cm/hopper/{id}/previewrecall \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7786 "name": "getPreviewRecall",
7787 "group": "Cm_Hopper",
7788 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7790 "filename": "server/api/cmHopper/index.js",
7791 "groupTitle": "Cm_Hopper"
7795 "url": "/api/cm/hopper/timezones",
7796 "title": "Gets TZs list",
7799 "title": "Example usage:",
7800 "content": "curl https://{domain}/api/cm/hopper/timezones -v -u {name}:{password} -X GET",
7804 "name": "getTimezones",
7805 "group": "Cm_Hopper",
7806 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7808 "filename": "server/api/cmHopper/index.js",
7809 "groupTitle": "Cm_Hopper"
7813 "url": "/api/cm/hopper/{id}",
7814 "title": "Update an existing Hopper",
7817 "title": "Example usage:",
7818 "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",
7822 "name": "updateHopper",
7823 "group": "Cm_Hopper",
7824 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7826 "filename": "server/api/cmHopper/index.js",
7827 "groupTitle": "Cm_Hopper"
7831 "url": "/api/cm/lists",
7832 "title": "Creates a new List",
7835 "title": "Example usage:",
7836 "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7840 "name": "CreateLists",
7841 "group": "Cm_Lists",
7856 "field": "description",
7863 "field": "dialPrefix",
7869 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7871 "filename": "server/api/cmList/index.js",
7872 "groupTitle": "Cm_Lists"
7876 "url": "/api/cm/lists/{id}",
7877 "title": "Deletes a List",
7880 "title": "Example usage:",
7881 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7885 "name": "DeleteLists",
7886 "group": "Cm_Lists",
7887 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7889 "filename": "server/api/cmList/index.js",
7890 "groupTitle": "Cm_Lists"
7894 "url": "/api/cm/lists/describe",
7895 "title": "Gets table info about Lists",
7898 "title": "Example usage:",
7899 "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7903 "name": "DescribeLists",
7904 "group": "Cm_Lists",
7905 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7907 "filename": "server/api/cmList/index.js",
7908 "groupTitle": "Cm_Lists"
7912 "url": "/api/cm/lists/{id}/users",
7913 "title": "Gets agents from list",
7916 "title": "Example usage:",
7917 "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7921 "name": "GetAgents",
7922 "group": "Cm_Lists",
7923 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7925 "filename": "server/api/cmList/index.js",
7926 "groupTitle": "Cm_Lists"
7930 "url": "/api/cm/lists",
7931 "title": "Gets a list of Lists",
7934 "title": "Example usage:",
7935 "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7940 "group": "Cm_Lists",
7941 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7943 "filename": "server/api/cmList/index.js",
7944 "groupTitle": "Cm_Lists"
7948 "url": "/api/cm/lists/{id}/users",
7949 "title": "Removes agents from a list",
7952 "title": "Example usage:",
7953 "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7957 "name": "RemoveAgents",
7958 "group": "Cm_Lists",
7959 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7961 "filename": "server/api/cmList/index.js",
7962 "groupTitle": "Cm_Lists"
7966 "url": "/api/cm/lists/{id}/dispositions",
7967 "title": "Removes dispositions from account",
7970 "title": "Example usage:",
7971 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7975 "name": "RemoveDispositions",
7976 "group": "Cm_Lists",
7977 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7979 "filename": "server/api/cmList/index.js",
7980 "groupTitle": "Cm_Lists"
7984 "url": "/api/cm/lists/{id}",
7985 "title": "Gets a single List",
7988 "title": "Example usage:",
7989 "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7993 "name": "ShowLists",
7994 "group": "Cm_Lists",
7995 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7997 "filename": "server/api/cmList/index.js",
7998 "groupTitle": "Cm_Lists"
8002 "url": "/api/cm/lists/{id}/users",
8003 "title": "Adds agents to a list",
8006 "title": "Example usage:",
8007 "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",
8011 "name": "addAgents",
8012 "group": "Cm_Lists",
8013 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8015 "filename": "server/api/cmList/index.js",
8016 "groupTitle": "Cm_Lists"
8020 "url": "/api/cm/lists/{id}/contacts",
8021 "title": "Creates new contacts",
8024 "title": "Example usage:",
8025 "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",
8029 "name": "addContacts",
8030 "group": "Cm_Lists",
8038 "field": "firstName",
8045 "field": "lastName",
8059 "field": "postalCode",
8080 "field": "dateOfBirth",
8087 "field": "description",
8129 "field": "facebook",
8185 "field": "telegram",
8199 "field": "priority",
8206 "field": "scheduledat",
8212 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8214 "filename": "server/api/cmList/index.js",
8215 "groupTitle": "Cm_Lists"
8219 "url": "/api/cm/lists/{id}/fields",
8220 "title": "Creates a new custom field",
8223 "title": "Example usage:",
8224 "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8228 "name": "addCustomField",
8229 "group": "Cm_Lists",
8230 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8232 "filename": "server/api/cmList/index.js",
8233 "groupTitle": "Cm_Lists"
8237 "url": "/api/cm/lists/{id}/dispositions",
8238 "title": "Creates new disposition",
8241 "title": "Example usage:",
8242 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8246 "name": "addDisposition",
8247 "group": "Cm_Lists",
8274 "field": "description",
8280 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8282 "filename": "server/api/cmList/index.js",
8283 "groupTitle": "Cm_Lists"
8287 "url": "/api/cm/lists/{id}/contacts",
8288 "title": "Gets List Contacts",
8291 "title": "Example usage:",
8292 "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
8296 "name": "getContacts",
8297 "group": "Cm_Lists",
8298 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8300 "filename": "server/api/cmList/index.js",
8301 "groupTitle": "Cm_Lists"
8305 "url": "/api/cm/lists/{id}/fields",
8306 "title": "Gets Custom Fields",
8309 "title": "Example usage:",
8310 "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
8314 "name": "getCustomFields",
8315 "group": "Cm_Lists",
8316 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8318 "filename": "server/api/cmList/index.js",
8319 "groupTitle": "Cm_Lists"
8323 "url": "/api/cm/lists/{id}/dispositions",
8324 "title": "Gets list dispositions",
8327 "title": "Example usage:",
8328 "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
8332 "name": "getDispositions",
8333 "group": "Cm_Lists",
8334 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8336 "filename": "server/api/cmList/index.js",
8337 "groupTitle": "Cm_Lists"
8341 "url": "/api/cm/lists/global_fields",
8342 "title": "Gets GLOBAL Custom Fields",
8345 "title": "Example usage:",
8346 "content": "curl https://{domain}/api/cm/lists/global_fields -v -u {name}:{password} -X GET",
8350 "name": "getGlobalCustomFields",
8351 "group": "Cm_Lists",
8352 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8354 "filename": "server/api/cmList/index.js",
8355 "groupTitle": "Cm_Lists"
8359 "url": "/api/cm/lists/{id}/contacts/csv",
8360 "title": "Gets CSV List Contacts",
8363 "title": "Example usage:",
8364 "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
8369 "group": "Cm_Lists",
8370 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8372 "filename": "server/api/cmList/index.js",
8373 "groupTitle": "Cm_Lists"
8377 "url": "/api/cm/lists/{id}",
8378 "title": "Update an existing List",
8381 "title": "Example usage:",
8382 "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",
8386 "name": "updateLists",
8387 "group": "Cm_Lists",
8388 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8390 "filename": "server/api/cmList/index.js",
8391 "groupTitle": "Cm_Lists"
8395 "url": "/api/cm/contacts/upload/:id",
8396 "title": "Import new contacts by csv",
8399 "title": "Example usage:",
8400 "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
8405 "group": "Cm_contacts",
8406 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8408 "filename": "server/api/cmContact/index.js",
8409 "groupTitle": "Cm_contacts"
8413 "url": "/api/cm/contacts/uploadUpdates/:id",
8414 "title": "Import existing contacts by csv",
8417 "title": "Example usage:",
8418 "content": "curl https://{domain}/api/cm/contacts/uploadUpdates/:id -v -u {name}:{password} -X POST",
8422 "name": "importUpdates",
8423 "group": "Cm_contacts",
8424 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8426 "filename": "server/api/cmContact/index.js",
8427 "groupTitle": "Cm_contacts"
8431 "url": "/api/cm/contacts/upload",
8432 "title": "Upload csv",
8435 "title": "Example usage:",
8436 "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
8441 "group": "Cm_contacts",
8442 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8444 "filename": "server/api/cmContact/index.js",
8445 "groupTitle": "Cm_contacts"
8449 "url": "/api/cm/contacts/csv",
8450 "title": "Create new contacts by csv",
8453 "title": "Example usage:",
8454 "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
8458 "name": "uploadCsv",
8459 "group": "Cm_contacts",
8460 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8462 "filename": "server/api/cmContact/index.js",
8463 "groupTitle": "Cm_contacts"
8467 "url": "/api/conditions/{id}",
8468 "title": "Deletes a Condition",
8471 "title": "Example usage:",
8472 "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
8476 "name": "DeleteConditions",
8477 "group": "Conditions",
8478 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8480 "filename": "server/api/condition/index.js",
8481 "groupTitle": "Conditions"
8485 "url": "/api/conditions/{id}",
8486 "title": "Update an existing Condition",
8489 "title": "Example usage:",
8490 "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8494 "name": "updateConditions",
8495 "group": "Conditions",
8496 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8498 "filename": "server/api/condition/index.js",
8499 "groupTitle": "Conditions"
8503 "url": "/api/contact_item_types",
8504 "title": "Creates a new ContactItemType",
8507 "title": "Example usage:",
8508 "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",
8512 "name": "CreateContactItemTypes",
8513 "group": "ContactItemType",
8535 "field": "rgbBackgroundColor",
8541 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8543 "filename": "server/api/contactItemType/index.js",
8544 "groupTitle": "ContactItemType"
8548 "url": "/api/contact_item_types/{id}",
8549 "title": "Deletes a ContactItemType",
8552 "title": "Example usage:",
8553 "content": "curl https://{domain}/api/contact_item_types/{id} -v -u {name}:{password} -X DELETE",
8557 "name": "DeleteContactItemTypes",
8558 "group": "ContactItemType",
8559 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8561 "filename": "server/api/contactItemType/index.js",
8562 "groupTitle": "ContactItemType"
8566 "url": "/api/contact_item_types",
8567 "title": "Gets a list of ContactItemTypes",
8570 "title": "Example usage:",
8571 "content": "curl https://{domain}/api/contact_item_types -v -u {name}:{password}",
8575 "name": "GetContactItemTypes",
8576 "group": "ContactItemType",
8577 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8579 "filename": "server/api/contactItemType/index.js",
8580 "groupTitle": "ContactItemType"
8584 "url": "/api/contact_item_types/{id}",
8585 "title": "Gets a single ContactItemType",
8588 "title": "Example usage:",
8589 "content": "curl https://{domain}/api/contact_item_types/{id} -v -u {name}:{password}",
8593 "name": "ShowContactItemTypes",
8594 "group": "ContactItemType",
8595 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8597 "filename": "server/api/contactItemType/index.js",
8598 "groupTitle": "ContactItemType"
8602 "url": "/api/contact_item_types/{id}",
8603 "title": "Update an existing ContactItemType",
8606 "title": "Example usage:",
8607 "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",
8611 "name": "updateContactItemTypes",
8612 "group": "ContactItemType",
8613 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8615 "filename": "server/api/contactItemType/index.js",
8616 "groupTitle": "ContactItemType"
8620 "url": "/api/cm/custom_field",
8621 "title": "Create a new custom field",
8624 "title": "Example usage:",
8625 "content": "curl https://{domain}/api/cm/custom_field -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8629 "name": "CreateCustomField",
8630 "group": "Custom_Fields",
8631 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8633 "filename": "server/api/cmCustomField/index.js",
8634 "groupTitle": "Custom_Fields"
8638 "url": "/api/dashboards/items",
8639 "title": "Create dasboard item",
8642 "title": "Example usage:",
8643 "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
8648 "group": "Dashboard_Items",
8649 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8651 "filename": "server/api/dashboardItem/index.js",
8652 "groupTitle": "Dashboard_Items"
8656 "url": "/api/dashboards/items/{id}",
8657 "title": "Deletes a Dashboard Item",
8660 "title": "Example usage:",
8661 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
8665 "name": "DeleteDashboard_Items",
8666 "group": "Dashboard_Items",
8667 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8669 "filename": "server/api/dashboardItem/index.js",
8670 "groupTitle": "Dashboard_Items"
8674 "url": "/api/dashboards/items/{id}",
8675 "title": "Gets a single Dashboard Item",
8678 "title": "Example usage:",
8679 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
8683 "name": "ShowDashboard_Items",
8684 "group": "Dashboard_Items",
8685 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8687 "filename": "server/api/dashboardItem/index.js",
8688 "groupTitle": "Dashboard_Items"
8692 "url": "/api/dashboards/items/{id}",
8693 "title": "Update an existing item",
8696 "title": "Example usage:",
8697 "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
8702 "group": "Dashboard_Items",
8703 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8705 "filename": "server/api/dashboardItem/index.js",
8706 "groupTitle": "Dashboard_Items"
8710 "url": "/api/dashboards/clone",
8711 "title": "Clone an existing Dashboard",
8714 "title": "Example usage:",
8715 "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8719 "name": "CloneDashboards",
8720 "group": "Dashboards",
8721 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8723 "filename": "server/api/dashboard/index.js",
8724 "groupTitle": "Dashboards"
8728 "url": "/api/dashboards",
8729 "title": "Creates a new Dashboard",
8732 "title": "Example usage:",
8733 "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8737 "name": "CreateDashboards",
8738 "group": "Dashboards",
8753 "field": "description",
8759 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8761 "filename": "server/api/dashboard/index.js",
8762 "groupTitle": "Dashboards"
8766 "url": "/api/dashboards/{id}",
8767 "title": "Deletes a Dashboard",
8770 "title": "Example usage:",
8771 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
8775 "name": "DeleteDashboards",
8776 "group": "Dashboards",
8777 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8779 "filename": "server/api/dashboard/index.js",
8780 "groupTitle": "Dashboards"
8784 "url": "/api/dashboards",
8785 "title": "Gets a list of Dashboards",
8788 "title": "Example usage:",
8789 "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8793 "name": "GetDashboards",
8794 "group": "Dashboards",
8795 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8797 "filename": "server/api/dashboard/index.js",
8798 "groupTitle": "Dashboards"
8802 "url": "/api/dashboards/{id}",
8803 "title": "Gets a single Dashboard",
8806 "title": "Example usage:",
8807 "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8811 "name": "ShowDashboards",
8812 "group": "Dashboards",
8813 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8815 "filename": "server/api/dashboard/index.js",
8816 "groupTitle": "Dashboards"
8820 "url": "/api/dashboards/{id}/items",
8821 "title": "Creates new item",
8824 "title": "Example usage:",
8825 "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8830 "group": "Dashboards",
8831 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8833 "filename": "server/api/dashboard/index.js",
8834 "groupTitle": "Dashboards"
8838 "url": "/api/dashboards/{id}/items",
8839 "title": "Gets items",
8842 "title": "Example usage:",
8843 "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8848 "group": "Dashboards",
8849 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8851 "filename": "server/api/dashboard/index.js",
8852 "groupTitle": "Dashboards"
8856 "url": "/api/dashboards/{id}",
8857 "title": "Update an existing Dashboard",
8860 "title": "Example usage:",
8861 "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8865 "name": "updateDashboards",
8866 "group": "Dashboards",
8867 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8869 "filename": "server/api/dashboard/index.js",
8870 "groupTitle": "Dashboards"
8874 "url": "/api/integrations/desk/accounts",
8875 "title": "Creates a new Desk Account",
8878 "title": "Example usage:",
8879 "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",
8883 "name": "CreateDesk_Accounts",
8884 "group": "Desk_Accounts",
8899 "field": "description",
8906 "field": "username",
8913 "field": "remoteUri",
8923 "field": "authType",
8930 "field": "password",
8937 "field": "consumerKey",
8944 "field": "consumerSecret",
8958 "field": "tokenSecret",
8965 "field": "serverUrl",
8972 "\"integrationTab\"",
8982 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8984 "filename": "server/api/intDeskAccount/index.js",
8985 "groupTitle": "Desk_Accounts"
8989 "url": "/api/integrations/desk/accounts/{id}",
8990 "title": "Deletes a Desk Account",
8993 "title": "Example usage:",
8994 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8998 "name": "DeleteDesk_Accounts",
8999 "group": "Desk_Accounts",
9000 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9002 "filename": "server/api/intDeskAccount/index.js",
9003 "groupTitle": "Desk_Accounts"
9007 "url": "/api/integrations/desk/accounts",
9008 "title": "Gets a list of Desk Accounts",
9011 "title": "Example usage:",
9012 "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
9016 "name": "GetDesk_Accounts",
9017 "group": "Desk_Accounts",
9018 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9020 "filename": "server/api/intDeskAccount/index.js",
9021 "groupTitle": "Desk_Accounts"
9025 "url": "/api/integrations/desk/accounts/{id}",
9026 "title": "Gets a single Desk Account",
9029 "title": "Example usage:",
9030 "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
9034 "name": "ShowDesk_Accounts",
9035 "group": "Desk_Accounts",
9036 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9038 "filename": "server/api/intDeskAccount/index.js",
9039 "groupTitle": "Desk_Accounts"
9043 "url": "/api/integrations/desk/accounts/{id}/configurations",
9044 "title": "Creates new configuration",
9047 "title": "Example usage:",
9048 "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",
9052 "name": "addConfiguration",
9053 "group": "Desk_Accounts",
9054 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9056 "filename": "server/api/intDeskAccount/index.js",
9057 "groupTitle": "Desk_Accounts"
9061 "url": "/api/integrations/desk/accounts/{id}/configurations",
9062 "title": "Gets account configurations",
9065 "title": "Example usage:",
9066 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9070 "name": "getConfigurations",
9071 "group": "Desk_Accounts",
9072 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9074 "filename": "server/api/intDeskAccount/index.js",
9075 "groupTitle": "Desk_Accounts"
9079 "url": "/api/integrations/desk/accounts/{id}/fields",
9080 "title": "Gets account fields",
9083 "title": "Example usage:",
9084 "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
9088 "name": "getFields",
9089 "group": "Desk_Accounts",
9090 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9092 "filename": "server/api/intDeskAccount/index.js",
9093 "groupTitle": "Desk_Accounts"
9097 "url": "/api/integrations/desk/accounts/{id}",
9098 "title": "Update an existing Desk Account",
9101 "title": "Example usage:",
9102 "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",
9106 "name": "updateDesk_Accounts",
9107 "group": "Desk_Accounts",
9108 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9110 "filename": "server/api/intDeskAccount/index.js",
9111 "groupTitle": "Desk_Accounts"
9115 "url": "/api/integrations/desk/configurations",
9116 "title": "Creates a new Desk Configuration",
9119 "title": "Example usage:",
9120 "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",
9124 "name": "CreateDesk_Configurations",
9125 "group": "Desk_Configurations",
9140 "field": "description",
9146 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9148 "filename": "server/api/intDeskConfiguration/index.js",
9149 "groupTitle": "Desk_Configurations"
9153 "url": "/api/integrations/desk/configurations/{id}",
9154 "title": "Deletes a Desk Configuration",
9157 "title": "Example usage:",
9158 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
9162 "name": "DeleteDesk_Configurations",
9163 "group": "Desk_Configurations",
9164 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9166 "filename": "server/api/intDeskConfiguration/index.js",
9167 "groupTitle": "Desk_Configurations"
9171 "url": "/api/integrations/desk/configurations",
9172 "title": "Gets a list of Desk Configurations",
9175 "title": "Example usage:",
9176 "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
9180 "name": "GetDesk_Configurations",
9181 "group": "Desk_Configurations",
9182 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9184 "filename": "server/api/intDeskConfiguration/index.js",
9185 "groupTitle": "Desk_Configurations"
9189 "url": "/api/integrations/desk/configurations/{id}",
9190 "title": "Gets a single Desk Configuration",
9193 "title": "Example usage:",
9194 "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
9198 "name": "ShowDesk_Configurations",
9199 "group": "Desk_Configurations",
9200 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9202 "filename": "server/api/intDeskConfiguration/index.js",
9203 "groupTitle": "Desk_Configurations"
9207 "url": "/api/integrations/desk/configurations/{id}/descriptions",
9208 "title": "Gets configurations descriptions",
9211 "title": "Example usage:",
9212 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9216 "name": "getDescriptions",
9217 "group": "Desk_Configurations",
9218 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9220 "filename": "server/api/intDeskConfiguration/index.js",
9221 "groupTitle": "Desk_Configurations"
9225 "url": "/api/integrations/desk/configurations/{id}/fields",
9226 "title": "Gets configurations fields",
9229 "title": "Example usage:",
9230 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
9234 "name": "getFields",
9235 "group": "Desk_Configurations",
9236 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9238 "filename": "server/api/intDeskConfiguration/index.js",
9239 "groupTitle": "Desk_Configurations"
9243 "url": "/api/integrations/desk/configurations/{id}/subjects",
9244 "title": "Gets configurations subjects",
9247 "title": "Example usage:",
9248 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9252 "name": "getSubjects",
9253 "group": "Desk_Configurations",
9254 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9256 "filename": "server/api/intDeskConfiguration/index.js",
9257 "groupTitle": "Desk_Configurations"
9261 "url": "/api/integrations/desk/configurations/{id}/tags",
9262 "title": "Gets configurations tags",
9265 "title": "Example usage:",
9266 "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
9271 "group": "Desk_Configurations",
9272 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9274 "filename": "server/api/intDeskConfiguration/index.js",
9275 "groupTitle": "Desk_Configurations"
9279 "url": "/api/integrations/desk/configurations/{id}/tags",
9280 "title": "Sets new tags",
9283 "title": "Example usage:",
9284 "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",
9289 "group": "Desk_Configurations",
9290 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9292 "filename": "server/api/intDeskConfiguration/index.js",
9293 "groupTitle": "Desk_Configurations"
9297 "url": "/api/integrations/desk/configurations/{id}",
9298 "title": "Update an existing Desk Configuration",
9301 "title": "Example usage:",
9302 "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",
9306 "name": "updateDesk_Configurations",
9307 "group": "Desk_Configurations",
9308 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9310 "filename": "server/api/intDeskConfiguration/index.js",
9311 "groupTitle": "Desk_Configurations"
9315 "url": "/api/integrations/desk/fields",
9316 "title": "Creates a new Desk Field",
9319 "title": "Example usage:",
9320 "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",
9324 "name": "CreateDesk_Fields",
9325 "group": "Desk_Fields",
9335 "\"customVariable\"",
9363 "\"customVariable\""
9373 "field": "keyContent",
9387 "field": "nameField",
9394 "field": "customField",
9401 "field": "variableName",
9407 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9409 "filename": "server/api/intDeskField/index.js",
9410 "groupTitle": "Desk_Fields"
9414 "url": "/api/integrations/desk/fields/{id}",
9415 "title": "Deletes a Desk Field",
9418 "title": "Example usage:",
9419 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
9423 "name": "DeleteDesk_Fields",
9424 "group": "Desk_Fields",
9425 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9427 "filename": "server/api/intDeskField/index.js",
9428 "groupTitle": "Desk_Fields"
9432 "url": "/api/integrations/desk/fields",
9433 "title": "Gets a list of Desk Fields",
9436 "title": "Example usage:",
9437 "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
9441 "name": "GetDesk_Fields",
9442 "group": "Desk_Fields",
9443 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9445 "filename": "server/api/intDeskField/index.js",
9446 "groupTitle": "Desk_Fields"
9450 "url": "/api/integrations/desk/fields/{id}",
9451 "title": "Gets a single Desk Field",
9454 "title": "Example usage:",
9455 "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
9459 "name": "ShowDesk_Fields",
9460 "group": "Desk_Fields",
9461 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9463 "filename": "server/api/intDeskField/index.js",
9464 "groupTitle": "Desk_Fields"
9468 "url": "/api/integrations/desk/fields/{id}",
9469 "title": "Update an existing Desk Field",
9472 "title": "Example usage:",
9473 "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",
9477 "name": "updateDesk_Fields",
9478 "group": "Desk_Fields",
9479 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9481 "filename": "server/api/intDeskField/index.js",
9482 "groupTitle": "Desk_Fields"
9486 "url": "/api/dispositions",
9487 "title": "Creates a new Disposition",
9490 "title": "Example usage:",
9491 "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9495 "name": "CreateDispositions",
9496 "group": "Dispositions",
9523 "field": "description",
9529 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9531 "filename": "server/api/disposition/index.js",
9532 "groupTitle": "Dispositions"
9536 "url": "/api/dispositions/{id}",
9537 "title": "Deletes a Disposition",
9540 "title": "Example usage:",
9541 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
9545 "name": "DeleteDispositions",
9546 "group": "Dispositions",
9547 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9549 "filename": "server/api/disposition/index.js",
9550 "groupTitle": "Dispositions"
9554 "url": "/api/dispositions",
9555 "title": "Gets a list of Dispositions",
9558 "title": "Example usage:",
9559 "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
9563 "name": "GetDispositions",
9564 "group": "Dispositions",
9565 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9567 "filename": "server/api/disposition/index.js",
9568 "groupTitle": "Dispositions"
9572 "url": "/api/dispositions/{id}",
9573 "title": "Gets a single Disposition",
9576 "title": "Example usage:",
9577 "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
9581 "name": "ShowDispositions",
9582 "group": "Dispositions",
9583 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9585 "filename": "server/api/disposition/index.js",
9586 "groupTitle": "Dispositions"
9590 "url": "/api/dispositions/{id}",
9591 "title": "Update an existing Disposition",
9594 "title": "Example usage:",
9595 "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9599 "name": "updateDispositions",
9600 "group": "Dispositions",
9601 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9603 "filename": "server/api/disposition/index.js",
9604 "groupTitle": "Dispositions"
9608 "url": "/api/integrations/dynamics365/accounts",
9609 "title": "Creates a new Dynamics365 Account",
9612 "title": "Example usage:",
9613 "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",
9617 "name": "CreateDynamics365_Accounts",
9618 "group": "Dynamics365_Accounts",
9633 "field": "username",
9640 "field": "password",
9647 "field": "remoteUri",
9654 "field": "tenantId",
9661 "field": "clientId",
9668 "field": "clientSecret",
9675 "field": "serverUrl",
9682 "field": "description",
9688 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9690 "filename": "server/api/intDynamics365Account/index.js",
9691 "groupTitle": "Dynamics365_Accounts"
9695 "url": "/api/integrations/dynamics365/accounts/{id}",
9696 "title": "Deletes a Dynamics365 Account",
9699 "title": "Example usage:",
9700 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
9704 "name": "DeleteDynamics365_Accounts",
9705 "group": "Dynamics365_Accounts",
9706 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9708 "filename": "server/api/intDynamics365Account/index.js",
9709 "groupTitle": "Dynamics365_Accounts"
9713 "url": "/api/integrations/dynamics365/accounts",
9714 "title": "Gets a list of Dynamics365 Accounts",
9717 "title": "Example usage:",
9718 "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
9722 "name": "GetDynamics365_Accounts",
9723 "group": "Dynamics365_Accounts",
9724 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9726 "filename": "server/api/intDynamics365Account/index.js",
9727 "groupTitle": "Dynamics365_Accounts"
9731 "url": "/api/integrations/dynamics365/accounts/{id}",
9732 "title": "Gets a single Dynamics365 Account",
9735 "title": "Example usage:",
9736 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
9740 "name": "ShowDynamics365_Accounts",
9741 "group": "Dynamics365_Accounts",
9742 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9744 "filename": "server/api/intDynamics365Account/index.js",
9745 "groupTitle": "Dynamics365_Accounts"
9749 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9750 "title": "Creates new configuration",
9753 "title": "Example usage:",
9754 "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",
9758 "name": "addConfiguration",
9759 "group": "Dynamics365_Accounts",
9760 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9762 "filename": "server/api/intDynamics365Account/index.js",
9763 "groupTitle": "Dynamics365_Accounts"
9767 "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9768 "title": "Gets account configurations",
9771 "title": "Example usage:",
9772 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9776 "name": "getConfigurations",
9777 "group": "Dynamics365_Accounts",
9778 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9780 "filename": "server/api/intDynamics365Account/index.js",
9781 "groupTitle": "Dynamics365_Accounts"
9785 "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9786 "title": "Gets account fields",
9789 "title": "Example usage:",
9790 "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9794 "name": "getFields",
9795 "group": "Dynamics365_Accounts",
9796 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9798 "filename": "server/api/intDynamics365Account/index.js",
9799 "groupTitle": "Dynamics365_Accounts"
9803 "url": "/api/integrations/dynamics365/accounts/{id}",
9804 "title": "Update an existing Dynamics365 Account",
9807 "title": "Example usage:",
9808 "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",
9812 "name": "updateDynamics365_Accounts",
9813 "group": "Dynamics365_Accounts",
9814 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9816 "filename": "server/api/intDynamics365Account/index.js",
9817 "groupTitle": "Dynamics365_Accounts"
9821 "url": "/api/integrations/dynamics365/configurations",
9822 "title": "Creates a new Dynamics365 Configuration",
9825 "title": "Example usage:",
9826 "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",
9830 "name": "CreateDynamics365_Configurations",
9831 "group": "Dynamics365_Configurations",
9846 "field": "description",
9857 "field": "ticketType",
9863 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9865 "filename": "server/api/intDynamics365Configuration/index.js",
9866 "groupTitle": "Dynamics365_Configurations"
9870 "url": "/api/integrations/dynamics365/configurations/{id}",
9871 "title": "Deletes a Dynamics365 Configuration",
9874 "title": "Example usage:",
9875 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9879 "name": "DeleteDynamics365_Configurations",
9880 "group": "Dynamics365_Configurations",
9881 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9883 "filename": "server/api/intDynamics365Configuration/index.js",
9884 "groupTitle": "Dynamics365_Configurations"
9888 "url": "/api/integrations/dynamics365/configurations",
9889 "title": "Gets a list of Dynamics365 Configurations",
9892 "title": "Example usage:",
9893 "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9897 "name": "GetDynamics365_Configurations",
9898 "group": "Dynamics365_Configurations",
9899 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9901 "filename": "server/api/intDynamics365Configuration/index.js",
9902 "groupTitle": "Dynamics365_Configurations"
9906 "url": "/api/integrations/dynamics365/configurations/{id}",
9907 "title": "Gets a single Dynamics365 Configuration",
9910 "title": "Example usage:",
9911 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9915 "name": "ShowDynamics365_Configurations",
9916 "group": "Dynamics365_Configurations",
9917 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9919 "filename": "server/api/intDynamics365Configuration/index.js",
9920 "groupTitle": "Dynamics365_Configurations"
9924 "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9925 "title": "Gets configurations descriptions",
9928 "title": "Example usage:",
9929 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9933 "name": "getDescriptions",
9934 "group": "Dynamics365_Configurations",
9935 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9937 "filename": "server/api/intDynamics365Configuration/index.js",
9938 "groupTitle": "Dynamics365_Configurations"
9942 "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9943 "title": "Gets configurations fields",
9946 "title": "Example usage:",
9947 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9951 "name": "getFields",
9952 "group": "Dynamics365_Configurations",
9953 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9955 "filename": "server/api/intDynamics365Configuration/index.js",
9956 "groupTitle": "Dynamics365_Configurations"
9960 "url": "/api/integrations/zoho/configurations/{id}/subjects",
9961 "title": "Gets configurations subjects",
9964 "title": "Example usage:",
9965 "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9969 "name": "getSubjects",
9970 "group": "Dynamics365_Configurations",
9971 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9973 "filename": "server/api/intDynamics365Configuration/index.js",
9974 "groupTitle": "Dynamics365_Configurations"
9978 "url": "/api/integrations/dynamics365/configurations/{id}",
9979 "title": "Update an existing Dynamics365 Configuration",
9982 "title": "Example usage:",
9983 "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",
9987 "name": "updateDynamics365_Configurations",
9988 "group": "Dynamics365_Configurations",
9989 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9991 "filename": "server/api/intDynamics365Configuration/index.js",
9992 "groupTitle": "Dynamics365_Configurations"
9996 "url": "/api/integrations/dynamics365/fields",
9997 "title": "Creates a new Dynamics365 Field",
10000 "title": "Example usage:",
10001 "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",
10005 "name": "CreateDynamics365_Fields",
10006 "group": "Dynamics365_Fields",
10016 "\"customVariable\"",
10028 "field": "content",
10044 "\"customVariable\""
10047 "field": "keyType",
10054 "field": "keyContent",
10061 "field": "idField",
10068 "field": "nameField",
10075 "field": "customField",
10082 "field": "variableName",
10088 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10089 "version": "0.0.0",
10090 "filename": "server/api/intDynamics365Field/index.js",
10091 "groupTitle": "Dynamics365_Fields"
10095 "url": "/api/integrations/dynamics365/fields/{id}",
10096 "title": "Deletes a Dynamics365 Field",
10099 "title": "Example usage:",
10100 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
10104 "name": "DeleteDynamics365_Fields",
10105 "group": "Dynamics365_Fields",
10106 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10107 "version": "0.0.0",
10108 "filename": "server/api/intDynamics365Field/index.js",
10109 "groupTitle": "Dynamics365_Fields"
10113 "url": "/api/integrations/dynamics365/fields",
10114 "title": "Gets a list of Dynamics365 Fields",
10117 "title": "Example usage:",
10118 "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
10122 "name": "GetDynamics365_Fields",
10123 "group": "Dynamics365_Fields",
10124 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10125 "version": "0.0.0",
10126 "filename": "server/api/intDynamics365Field/index.js",
10127 "groupTitle": "Dynamics365_Fields"
10131 "url": "/api/integrations/dynamics365/fields/{id}",
10132 "title": "Gets a single Dynamics365 Field",
10135 "title": "Example usage:",
10136 "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
10140 "name": "ShowDynamics365_Fields",
10141 "group": "Dynamics365_Fields",
10142 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10143 "version": "0.0.0",
10144 "filename": "server/api/intDynamics365Field/index.js",
10145 "groupTitle": "Dynamics365_Fields"
10149 "url": "/api/integrations/dynamics365/fields/{id}",
10150 "title": "Update an existing Dynamics365 Field",
10153 "title": "Example usage:",
10154 "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",
10158 "name": "updateDynamics365_Fields",
10159 "group": "Dynamics365_Fields",
10160 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10161 "version": "0.0.0",
10162 "filename": "server/api/intDynamics365Field/index.js",
10163 "groupTitle": "Dynamics365_Fields"
10167 "url": "/api/fax/accounts/{id}/users",
10168 "title": "Add agents to a fax account",
10171 "title": "Example usage:",
10172 "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",
10176 "name": "AddAgents",
10177 "group": "Fax_Accounts",
10178 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10179 "version": "0.0.0",
10180 "filename": "server/api/faxAccount/index.js",
10181 "groupTitle": "Fax_Accounts"
10185 "url": "/api/fax/accounts",
10186 "title": "Creates a new Account",
10189 "title": "Example usage:",
10190 "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10194 "name": "CreateAccounts",
10195 "group": "Fax_Accounts",
10210 "field": "description",
10228 "field": "headerinfo",
10235 "field": "localstationid",
10250 "field": "minrate",
10265 "field": "maxrate",
10279 "field": "gateway",
10286 "field": "faxdetect",
10293 "field": "t38timeout",
10320 "field": "notificationTemplate",
10327 "field": "notificationSound",
10334 "field": "notificationShake",
10341 "field": "waitForTheAssignedAgent",
10348 "field": "queueTransfer",
10355 "field": "queueTransferTimeout",
10362 "field": "agentTransfer",
10369 "field": "agentTransferTimeout",
10376 "field": "mandatoryDispositionPauseId",
10377 "description": "<p>Status to put when mandatory disposition is enabled</p>"
10383 "field": "mandatoryDisposition",
10384 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
10389 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10390 "version": "0.0.0",
10391 "filename": "server/api/faxAccount/index.js",
10392 "groupTitle": "Fax_Accounts"
10396 "url": "/api/fax/accounts/{id}",
10397 "title": "Deletes a Account",
10400 "title": "Example usage:",
10401 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
10405 "name": "DeleteAccounts",
10406 "group": "Fax_Accounts",
10407 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10408 "version": "0.0.0",
10409 "filename": "server/api/faxAccount/index.js",
10410 "groupTitle": "Fax_Accounts"
10414 "url": "/api/fax/accounts/describe",
10415 "title": "Gets table info about Accounts",
10418 "title": "Example usage:",
10419 "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
10423 "name": "DescribeAccounts",
10424 "group": "Fax_Accounts",
10425 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10426 "version": "0.0.0",
10427 "filename": "server/api/faxAccount/index.js",
10428 "groupTitle": "Fax_Accounts"
10432 "url": "/api/fax/accounts",
10433 "title": "Gets a list of Accounts",
10436 "title": "Example usage:",
10437 "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
10441 "name": "GetAccounts",
10442 "group": "Fax_Accounts",
10443 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10444 "version": "0.0.0",
10445 "filename": "server/api/faxAccount/index.js",
10446 "groupTitle": "Fax_Accounts"
10450 "url": "/api/fax/accounts/{id}/users",
10451 "title": "Gets agents from fax account",
10454 "title": "Example usage:",
10455 "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
10459 "name": "GetAgents",
10460 "group": "Fax_Accounts",
10461 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10462 "version": "0.0.0",
10463 "filename": "server/api/faxAccount/index.js",
10464 "groupTitle": "Fax_Accounts"
10468 "url": "/api/fax/accounts/{id}/users",
10469 "title": "Removes agents from a fax account",
10472 "title": "Example usage:",
10473 "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10477 "name": "RemoveAgents",
10478 "group": "Fax_Accounts",
10479 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10480 "version": "0.0.0",
10481 "filename": "server/api/faxAccount/index.js",
10482 "groupTitle": "Fax_Accounts"
10486 "url": "/api/fax/accounts/{id}/canned_answers",
10487 "title": "Removes canned answers from account",
10490 "title": "Example usage:",
10491 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10495 "name": "RemoveAnswers",
10496 "group": "Fax_Accounts",
10497 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10498 "version": "0.0.0",
10499 "filename": "server/api/faxAccount/index.js",
10500 "groupTitle": "Fax_Accounts"
10504 "url": "/api/fax/accounts/{id}/dispositions",
10505 "title": "Removes dispositions from account",
10508 "title": "Example usage:",
10509 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10513 "name": "RemoveDispositions",
10514 "group": "Fax_Accounts",
10515 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10516 "version": "0.0.0",
10517 "filename": "server/api/faxAccount/index.js",
10518 "groupTitle": "Fax_Accounts"
10522 "url": "/api/fax/accounts/{id}",
10523 "title": "Gets a single Account",
10526 "title": "Example usage:",
10527 "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
10531 "name": "ShowAccounts",
10532 "group": "Fax_Accounts",
10533 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10534 "version": "0.0.0",
10535 "filename": "server/api/faxAccount/index.js",
10536 "groupTitle": "Fax_Accounts"
10540 "url": "/api/fax/accounts/{id}/canned_answers",
10541 "title": "Creates new canned answer",
10544 "title": "Example usage:",
10545 "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",
10549 "name": "addAnswer",
10550 "group": "Fax_Accounts",
10572 "field": "description",
10585 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10586 "version": "0.0.0",
10587 "filename": "server/api/faxAccount/index.js",
10588 "groupTitle": "Fax_Accounts"
10592 "url": "/api/fax/accounts/{id}/applications",
10593 "title": "Creates new applications",
10596 "title": "Example usage:",
10597 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10601 "name": "addApplications",
10602 "group": "Fax_Accounts",
10610 "field": "priority",
10624 "field": "appdata",
10631 "field": "description",
10638 "field": "interval",
10644 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10645 "version": "0.0.0",
10646 "filename": "server/api/faxAccount/index.js",
10647 "groupTitle": "Fax_Accounts"
10651 "url": "/api/fax/accounts/addaccountapplications",
10652 "title": "Creates new account and applications",
10655 "title": "Example usage:",
10656 "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10660 "name": "addApplications",
10661 "group": "Fax_Accounts",
10669 "field": "priority",
10683 "field": "appdata",
10690 "field": "description",
10697 "field": "interval",
10703 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10704 "version": "0.0.0",
10705 "filename": "server/api/faxAccount/index.js",
10706 "groupTitle": "Fax_Accounts"
10710 "url": "/api/fax/accounts/{id}/dispositions",
10711 "title": "Creates new disposition",
10714 "title": "Example usage:",
10715 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10719 "name": "addDisposition",
10720 "group": "Fax_Accounts",
10747 "field": "description",
10753 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10754 "version": "0.0.0",
10755 "filename": "server/api/faxAccount/index.js",
10756 "groupTitle": "Fax_Accounts"
10760 "url": "/api/fax/accounts/{id}/interactions",
10761 "title": "Creates new interactions",
10764 "title": "Example usage:",
10765 "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",
10769 "name": "addInteraction",
10770 "group": "Fax_Accounts",
10785 "field": "closedAt",
10792 "field": "disposition",
10799 "field": "secondDisposition",
10806 "field": "thirdDisposition",
10820 "field": "read1stAt",
10838 "field": "firstMsgDirection",
10845 "field": "lastMsgAt",
10856 "field": "lastMsgDirection",
10862 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10863 "version": "0.0.0",
10864 "filename": "server/api/faxAccount/index.js",
10865 "groupTitle": "Fax_Accounts"
10869 "url": "/api/fax/accounts/{id}/canned_answers",
10870 "title": "Gets account canned answers",
10873 "title": "Example usage:",
10874 "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10878 "name": "getAnswers",
10879 "group": "Fax_Accounts",
10880 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10881 "version": "0.0.0",
10882 "filename": "server/api/faxAccount/index.js",
10883 "groupTitle": "Fax_Accounts"
10887 "url": "/api/fax/accounts/{id}/applications",
10888 "title": "Gets account pplications",
10891 "title": "Example usage:",
10892 "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10896 "name": "getApplications",
10897 "group": "Fax_Accounts",
10898 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10899 "version": "0.0.0",
10900 "filename": "server/api/faxAccount/index.js",
10901 "groupTitle": "Fax_Accounts"
10905 "url": "/api/fax/accounts/{id}/dispositions",
10906 "title": "Gets account dispositions",
10909 "title": "Example usage:",
10910 "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10914 "name": "getDispositions",
10915 "group": "Fax_Accounts",
10916 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10917 "version": "0.0.0",
10918 "filename": "server/api/faxAccount/index.js",
10919 "groupTitle": "Fax_Accounts"
10923 "url": "/api/fax/accounts/{id}/interactions",
10924 "title": "Gets account interactions",
10927 "title": "Example usage:",
10928 "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10932 "name": "getInteraction",
10933 "group": "Fax_Accounts",
10934 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10935 "version": "0.0.0",
10936 "filename": "server/api/faxAccount/index.js",
10937 "groupTitle": "Fax_Accounts"
10941 "url": "/api/fax/accounts/{id}/messages",
10942 "title": "Gets account messages",
10945 "title": "Example usage:",
10946 "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10950 "name": "getMessages",
10951 "group": "Fax_Accounts",
10952 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10953 "version": "0.0.0",
10954 "filename": "server/api/faxAccount/index.js",
10955 "groupTitle": "Fax_Accounts"
10959 "url": "/api/fax/accounts/{id}/send",
10960 "title": "Send new fax",
10963 "title": "Example usage:",
10964 "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",
10969 "group": "Fax_Accounts",
10970 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10971 "version": "0.0.0",
10972 "filename": "server/api/faxAccount/index.js",
10973 "groupTitle": "Fax_Accounts"
10977 "url": "/api/fax/accounts/{id}",
10978 "title": "Update an existing Account",
10981 "title": "Example usage:",
10982 "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",
10986 "name": "updateAccounts",
10987 "group": "Fax_Accounts",
10988 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10989 "version": "0.0.0",
10990 "filename": "server/api/faxAccount/index.js",
10991 "groupTitle": "Fax_Accounts"
10995 "url": "/api/fax/accounts/updateaccountapplications",
10996 "title": "Update account and applications",
10999 "title": "Example usage:",
11000 "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11004 "name": "updateApplications",
11005 "group": "Fax_Accounts",
11013 "field": "priority",
11027 "field": "appdata",
11034 "field": "description",
11041 "field": "interval",
11047 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11048 "version": "0.0.0",
11049 "filename": "server/api/faxAccount/index.js",
11050 "groupTitle": "Fax_Accounts"
11054 "url": "/api/fax/applications",
11055 "title": "Creates a new Application",
11058 "title": "Example usage:",
11059 "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11063 "name": "CreateApplications",
11064 "group": "Fax_Applications",
11072 "field": "priority",
11086 "field": "appdata",
11093 "field": "description",
11100 "field": "interval",
11106 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11107 "version": "0.0.0",
11108 "filename": "server/api/faxApplication/index.js",
11109 "groupTitle": "Fax_Applications"
11113 "url": "/api/fax/applications/{id}",
11114 "title": "Deletes a Application",
11117 "title": "Example usage:",
11118 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
11122 "name": "DeleteApplications",
11123 "group": "Fax_Applications",
11124 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11125 "version": "0.0.0",
11126 "filename": "server/api/faxApplication/index.js",
11127 "groupTitle": "Fax_Applications"
11131 "url": "/api/fax/applications",
11132 "title": "Gets a list of Applications",
11135 "title": "Example usage:",
11136 "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
11140 "name": "GetApplications",
11141 "group": "Fax_Applications",
11142 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11143 "version": "0.0.0",
11144 "filename": "server/api/faxApplication/index.js",
11145 "groupTitle": "Fax_Applications"
11149 "url": "/api/fax/applications/{id}",
11150 "title": "Gets a single Application",
11153 "title": "Example usage:",
11154 "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
11158 "name": "ShowApplications",
11159 "group": "Fax_Applications",
11160 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11161 "version": "0.0.0",
11162 "filename": "server/api/faxApplication/index.js",
11163 "groupTitle": "Fax_Applications"
11167 "url": "/api/fax/applications/{id}",
11168 "title": "Update an existing Application",
11171 "title": "Example usage:",
11172 "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",
11176 "name": "updateApplications",
11177 "group": "Fax_Applications",
11178 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11179 "version": "0.0.0",
11180 "filename": "server/api/faxApplication/index.js",
11181 "groupTitle": "Fax_Applications"
11185 "url": "/api/fax/interactions/{id}/tags",
11186 "title": "Add tags to the interaction",
11189 "title": "Example usage:",
11190 "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",
11195 "group": "Fax_Interactions",
11196 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11197 "version": "0.0.0",
11198 "filename": "server/api/faxInteraction/index.js",
11199 "groupTitle": "Fax_Interactions"
11203 "url": "/api/fax/interactions",
11204 "title": "Creates a new Interaction",
11207 "title": "Example usage:",
11208 "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11212 "name": "CreateInteractions",
11213 "group": "Fax_Interactions",
11228 "field": "closedAt",
11235 "field": "disposition",
11242 "field": "secondDisposition",
11249 "field": "thirdDisposition",
11263 "field": "read1stAt",
11281 "field": "firstMsgDirection",
11288 "field": "lastMsgAt",
11299 "field": "lastMsgDirection",
11305 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11306 "version": "0.0.0",
11307 "filename": "server/api/faxInteraction/index.js",
11308 "groupTitle": "Fax_Interactions"
11312 "url": "/api/fax/interactions/{id}",
11313 "title": "Deletes a Interaction",
11316 "title": "Example usage:",
11317 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
11321 "name": "DeleteInteractions",
11322 "group": "Fax_Interactions",
11323 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11324 "version": "0.0.0",
11325 "filename": "server/api/faxInteraction/index.js",
11326 "groupTitle": "Fax_Interactions"
11330 "url": "/api/fax/interactions/describe",
11331 "title": "Gets table info about Interactions",
11334 "title": "Example usage:",
11335 "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
11339 "name": "DescribeInteractions",
11340 "group": "Fax_Interactions",
11341 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11342 "version": "0.0.0",
11343 "filename": "server/api/faxInteraction/index.js",
11344 "groupTitle": "Fax_Interactions"
11348 "url": "/api/fax/interactions",
11349 "title": "Gets a list of Interactions",
11352 "title": "Example usage:",
11353 "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
11357 "name": "GetInteractions",
11358 "group": "Fax_Interactions",
11359 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11360 "version": "0.0.0",
11361 "filename": "server/api/faxInteraction/index.js",
11362 "groupTitle": "Fax_Interactions"
11366 "url": "/api/fax/interactions/{id}/tags",
11367 "title": "Removes tags from interaction",
11370 "title": "Example usage:",
11371 "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11375 "name": "RemoveTags",
11376 "group": "Fax_Interactions",
11377 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11378 "version": "0.0.0",
11379 "filename": "server/api/faxInteraction/index.js",
11380 "groupTitle": "Fax_Interactions"
11384 "url": "/api/fax/interactions/{id}",
11385 "title": "Gets a single Interaction",
11388 "title": "Example usage:",
11389 "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
11393 "name": "ShowInteractions",
11394 "group": "Fax_Interactions",
11395 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11396 "version": "0.0.0",
11397 "filename": "server/api/faxInteraction/index.js",
11398 "groupTitle": "Fax_Interactions"
11402 "url": "/api/fax/interactions/{id}/messages",
11403 "title": "Creates new messages",
11406 "title": "Example usage:",
11407 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11411 "name": "addMessage",
11412 "group": "Fax_Interactions",
11438 "field": "direction",
11445 "field": "failMessage",
11458 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11459 "version": "0.0.0",
11460 "filename": "server/api/faxInteraction/index.js",
11461 "groupTitle": "Fax_Interactions"
11465 "url": "/api/fax/interactions/{id}/download",
11466 "title": "Get interactions",
11469 "title": "Example usage:",
11470 "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
11474 "name": "download",
11475 "group": "Fax_Interactions",
11476 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11477 "version": "0.0.0",
11478 "filename": "server/api/faxInteraction/index.js",
11479 "groupTitle": "Fax_Interactions"
11483 "url": "/api/fax/interactions/{id}/messages",
11484 "title": "Gets interaction messages",
11487 "title": "Example usage:",
11488 "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
11492 "name": "getMessages",
11493 "group": "Fax_Interactions",
11494 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11495 "version": "0.0.0",
11496 "filename": "server/api/faxInteraction/index.js",
11497 "groupTitle": "Fax_Interactions"
11501 "url": "/api/fax/interactions/{id}",
11502 "title": "Update an existing Interaction",
11505 "title": "Example usage:",
11506 "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",
11510 "name": "updateInteractions",
11511 "group": "Fax_Interactions",
11512 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11513 "version": "0.0.0",
11514 "filename": "server/api/faxInteraction/index.js",
11515 "groupTitle": "Fax_Interactions"
11519 "url": "/api/fax/messages/{id}/download",
11520 "title": "Get message",
11523 "title": "Example usage:",
11524 "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
11528 "name": "download",
11529 "group": "Fax_Message",
11530 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11531 "version": "0.0.0",
11532 "filename": "server/api/faxMessage/index.js",
11533 "groupTitle": "Fax_Message"
11537 "url": "/api/fax/messages/{id}",
11538 "title": "Deletes a Message",
11541 "title": "Example usage:",
11542 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
11546 "name": "DeleteMessages",
11547 "group": "Fax_Messages",
11548 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11549 "version": "0.0.0",
11550 "filename": "server/api/faxMessage/index.js",
11551 "groupTitle": "Fax_Messages"
11555 "url": "/api/fax/messages/describe",
11556 "title": "Gets table info about Messages",
11559 "title": "Example usage:",
11560 "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
11564 "name": "DescribeMessages",
11565 "group": "Fax_Messages",
11566 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11567 "version": "0.0.0",
11568 "filename": "server/api/faxMessage/index.js",
11569 "groupTitle": "Fax_Messages"
11573 "url": "/api/fax/messages",
11574 "title": "Gets a list of Messages",
11577 "title": "Example usage:",
11578 "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
11582 "name": "GetMessages",
11583 "group": "Fax_Messages",
11584 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11585 "version": "0.0.0",
11586 "filename": "server/api/faxMessage/index.js",
11587 "groupTitle": "Fax_Messages"
11591 "url": "/api/fax/messages/{id}",
11592 "title": "Gets a single Message",
11595 "title": "Example usage:",
11596 "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
11600 "name": "ShowMessages",
11601 "group": "Fax_Messages",
11602 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11603 "version": "0.0.0",
11604 "filename": "server/api/faxMessage/index.js",
11605 "groupTitle": "Fax_Messages"
11609 "url": "/api/fax/messages/{id}/accept",
11610 "title": "Accepts message",
11613 "title": "Example usage:",
11614 "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11618 "name": "acceptMessage",
11619 "group": "Fax_Messages",
11620 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11621 "version": "0.0.0",
11622 "filename": "server/api/faxMessage/index.js",
11623 "groupTitle": "Fax_Messages"
11627 "url": "/api/fax/messages",
11628 "title": "Create message and send Fax",
11631 "title": "Example usage:",
11632 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11636 "name": "rejectMessage",
11637 "group": "Fax_Messages",
11638 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11639 "version": "0.0.0",
11640 "filename": "server/api/faxMessage/index.js",
11641 "groupTitle": "Fax_Messages"
11645 "url": "/api/fax/messages/{id}/reject",
11646 "title": "Rejects message",
11649 "title": "Example usage:",
11650 "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11654 "name": "rejectMessage",
11655 "group": "Fax_Messages",
11656 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11657 "version": "0.0.0",
11658 "filename": "server/api/faxMessage/index.js",
11659 "groupTitle": "Fax_Messages"
11663 "url": "/api/fax/messages/{id}",
11664 "title": "Update an existing Message",
11667 "title": "Example usage:",
11668 "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",
11672 "name": "updateMessages",
11673 "group": "Fax_Messages",
11674 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11675 "version": "0.0.0",
11676 "filename": "server/api/faxMessage/index.js",
11677 "groupTitle": "Fax_Messages"
11681 "url": "/api/fax/reports/queue",
11682 "title": "Creates a new Fax Queue Report",
11685 "title": "Example usage:",
11686 "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",
11690 "name": "CreateFax_Queue_Reports",
11691 "group": "Fax_Queue_Reports",
11699 "field": "uniqueid",
11720 "field": "leaveAt",
11727 "field": "acceptAt",
11747 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11748 "version": "0.0.0",
11749 "filename": "server/api/faxQueueReport/index.js",
11750 "groupTitle": "Fax_Queue_Reports"
11754 "url": "/api/fax/reports/queue/{id}",
11755 "title": "Deletes a Fax Queue Report",
11758 "title": "Example usage:",
11759 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
11763 "name": "DeleteFax_Queue_Reports",
11764 "group": "Fax_Queue_Reports",
11765 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11766 "version": "0.0.0",
11767 "filename": "server/api/faxQueueReport/index.js",
11768 "groupTitle": "Fax_Queue_Reports"
11772 "url": "/api/fax/reports/queue/describe",
11773 "title": "Gets table info about Fax Queue Reports",
11776 "title": "Example usage:",
11777 "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11781 "name": "DescribeFax_Queue_Reports",
11782 "group": "Fax_Queue_Reports",
11783 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11784 "version": "0.0.0",
11785 "filename": "server/api/faxQueueReport/index.js",
11786 "groupTitle": "Fax_Queue_Reports"
11790 "url": "/api/fax/reports/queue",
11791 "title": "Gets a list of Fax Queue Reports",
11794 "title": "Example usage:",
11795 "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11799 "name": "GetFax_Queue_Reports",
11800 "group": "Fax_Queue_Reports",
11801 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11802 "version": "0.0.0",
11803 "filename": "server/api/faxQueueReport/index.js",
11804 "groupTitle": "Fax_Queue_Reports"
11808 "url": "/api/fax/reports/queue/{id}",
11809 "title": "Gets a single Fax Queue Report",
11812 "title": "Example usage:",
11813 "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11817 "name": "ShowFax_Queue_Reports",
11818 "group": "Fax_Queue_Reports",
11819 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11820 "version": "0.0.0",
11821 "filename": "server/api/faxQueueReport/index.js",
11822 "groupTitle": "Fax_Queue_Reports"
11826 "url": "/api/fax/reports/queue/{id}",
11827 "title": "Update an existing Fax Queue Report",
11830 "title": "Example usage:",
11831 "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",
11835 "name": "updateFax_Queue_Reports",
11836 "group": "Fax_Queue_Reports",
11837 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11838 "version": "0.0.0",
11839 "filename": "server/api/faxQueueReport/index.js",
11840 "groupTitle": "Fax_Queue_Reports"
11844 "url": "/api/fax/queues/{id}/users",
11845 "title": "Add agents to a queue",
11848 "title": "Example usage:",
11849 "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",
11853 "name": "AddAgents",
11854 "group": "Fax_Queues",
11855 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11856 "version": "0.0.0",
11857 "filename": "server/api/faxQueue/index.js",
11858 "groupTitle": "Fax_Queues"
11862 "url": "/api/fax/queues/{id}/teams",
11863 "title": "Add teams to a queue",
11866 "title": "Example usage:",
11867 "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",
11871 "name": "AddTeams",
11872 "group": "Fax_Queues",
11873 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11874 "version": "0.0.0",
11875 "filename": "server/api/faxQueue/index.js",
11876 "groupTitle": "Fax_Queues"
11880 "url": "/api/fax/queues",
11881 "title": "Creates a new Queue",
11884 "title": "Example usage:",
11885 "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11889 "name": "CreateQueues",
11890 "group": "Fax_Queues",
11905 "field": "description",
11912 "field": "timeout",
11924 "field": "strategy",
11931 "field": "lastAgent",
11937 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11938 "version": "0.0.0",
11939 "filename": "server/api/faxQueue/index.js",
11940 "groupTitle": "Fax_Queues"
11944 "url": "/api/fax/queues/{id}",
11945 "title": "Deletes a Queue",
11948 "title": "Example usage:",
11949 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11953 "name": "DeleteQueues",
11954 "group": "Fax_Queues",
11955 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11956 "version": "0.0.0",
11957 "filename": "server/api/faxQueue/index.js",
11958 "groupTitle": "Fax_Queues"
11962 "url": "/api/fax/queues/describe",
11963 "title": "Gets table info about Queues",
11966 "title": "Example usage:",
11967 "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11971 "name": "DescribeQueues",
11972 "group": "Fax_Queues",
11973 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11974 "version": "0.0.0",
11975 "filename": "server/api/faxQueue/index.js",
11976 "groupTitle": "Fax_Queues"
11980 "url": "/api/fax/queues/{id}/users",
11981 "title": "Gets queue agents",
11984 "title": "Example usage:",
11985 "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11989 "name": "GetAgents",
11990 "group": "Fax_Queues",
11991 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11992 "version": "0.0.0",
11993 "filename": "server/api/faxQueue/index.js",
11994 "groupTitle": "Fax_Queues"
11998 "url": "/api/fax/queues/{id}/members",
11999 "title": "GetMembers",
12002 "title": "Example usage:",
12003 "content": "curl https://{domain}/api/fax/queues/{id}/members -v -u {name}:{password}",
12007 "name": "GetMembers",
12008 "group": "Fax_Queues",
12009 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12010 "version": "0.0.0",
12011 "filename": "server/api/faxQueue/index.js",
12012 "groupTitle": "Fax_Queues"
12016 "url": "/api/fax/queues",
12017 "title": "Gets a list of Queues",
12020 "title": "Example usage:",
12021 "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
12025 "name": "GetQueues",
12026 "group": "Fax_Queues",
12027 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12028 "version": "0.0.0",
12029 "filename": "server/api/faxQueue/index.js",
12030 "groupTitle": "Fax_Queues"
12034 "url": "/api/fax/queues/{id}/teams",
12035 "title": "Gets queues list",
12038 "title": "Example usage:",
12039 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
12043 "name": "GetTeams",
12044 "group": "Fax_Queues",
12045 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12046 "version": "0.0.0",
12047 "filename": "server/api/faxQueue/index.js",
12048 "groupTitle": "Fax_Queues"
12052 "url": "/api/fax/queues/{id}/users",
12053 "title": "Removes agents from a queue",
12056 "title": "Example usage:",
12057 "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
12061 "name": "RemoveAgents",
12062 "group": "Fax_Queues",
12063 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12064 "version": "0.0.0",
12065 "filename": "server/api/faxQueue/index.js",
12066 "groupTitle": "Fax_Queues"
12070 "url": "/api/fax/queues/{id}",
12071 "title": "Gets a single Queue",
12074 "title": "Example usage:",
12075 "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
12079 "name": "ShowQueues",
12080 "group": "Fax_Queues",
12081 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12082 "version": "0.0.0",
12083 "filename": "server/api/faxQueue/index.js",
12084 "groupTitle": "Fax_Queues"
12088 "url": "/api/fax/queues/{id}",
12089 "title": "Update an existing Queue",
12092 "title": "Example usage:",
12093 "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",
12097 "name": "updateQueues",
12098 "group": "Fax_Queues",
12099 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12100 "version": "0.0.0",
12101 "filename": "server/api/faxQueue/index.js",
12102 "groupTitle": "Fax_Queues"
12106 "url": "/api/fax/reports/transfer",
12107 "title": "Creates a new Fax Transfer Report",
12110 "title": "Example usage:",
12111 "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",
12115 "name": "CreateFax_Transfer_Reports",
12116 "group": "Fax_Transfer_Reports",
12124 "field": "uniqueid",
12143 "field": "transferredAt",
12149 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12150 "version": "0.0.0",
12151 "filename": "server/api/faxTransferReport/index.js",
12152 "groupTitle": "Fax_Transfer_Reports"
12156 "url": "/api/fax/reports/transfer/{id}",
12157 "title": "Deletes a Fax Transfer Report",
12160 "title": "Example usage:",
12161 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
12165 "name": "DeleteFax_Transfer_Reports",
12166 "group": "Fax_Transfer_Reports",
12167 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12168 "version": "0.0.0",
12169 "filename": "server/api/faxTransferReport/index.js",
12170 "groupTitle": "Fax_Transfer_Reports"
12174 "url": "/api/fax/reports/transfer/describe",
12175 "title": "Gets table info about Fax Transfer Reports",
12178 "title": "Example usage:",
12179 "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
12183 "name": "DescribeFax_Transfer_Reports",
12184 "group": "Fax_Transfer_Reports",
12185 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12186 "version": "0.0.0",
12187 "filename": "server/api/faxTransferReport/index.js",
12188 "groupTitle": "Fax_Transfer_Reports"
12192 "url": "/api/fax/reports/transfer",
12193 "title": "Gets a list of Fax Transfer Reports",
12196 "title": "Example usage:",
12197 "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
12201 "name": "GetFax_Transfer_Reports",
12202 "group": "Fax_Transfer_Reports",
12203 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12204 "version": "0.0.0",
12205 "filename": "server/api/faxTransferReport/index.js",
12206 "groupTitle": "Fax_Transfer_Reports"
12210 "url": "/api/fax/reports/transfer/{id}",
12211 "title": "Gets a single Fax Transfer Report",
12214 "title": "Example usage:",
12215 "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
12219 "name": "ShowFax_Transfer_Reports",
12220 "group": "Fax_Transfer_Reports",
12221 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12222 "version": "0.0.0",
12223 "filename": "server/api/faxTransferReport/index.js",
12224 "groupTitle": "Fax_Transfer_Reports"
12228 "url": "/api/fax/reports/transfer/{id}",
12229 "title": "Update an existing Fax Transfer Report",
12232 "title": "Example usage:",
12233 "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",
12237 "name": "updateFax_Transfer_Reports",
12238 "group": "Fax_Transfer_Reports",
12239 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12240 "version": "0.0.0",
12241 "filename": "server/api/faxTransferReport/index.js",
12242 "groupTitle": "Fax_Transfer_Reports"
12246 "url": "/api/integrations/freshdesk/accounts",
12247 "title": "Creates a new Freshdesk Account",
12250 "title": "Example usage:",
12251 "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",
12255 "name": "CreateFreshdesk_Accounts",
12256 "group": "Freshdesk_Accounts",
12271 "field": "description",
12278 "field": "username",
12292 "field": "remoteUri",
12299 "field": "serverUrl",
12305 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12306 "version": "0.0.0",
12307 "filename": "server/api/intFreshdeskAccount/index.js",
12308 "groupTitle": "Freshdesk_Accounts"
12312 "url": "/api/integrations/freshdesk/accounts/{id}",
12313 "title": "Deletes a Freshdesk Account",
12316 "title": "Example usage:",
12317 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
12321 "name": "DeleteFreshdesk_Accounts",
12322 "group": "Freshdesk_Accounts",
12323 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12324 "version": "0.0.0",
12325 "filename": "server/api/intFreshdeskAccount/index.js",
12326 "groupTitle": "Freshdesk_Accounts"
12330 "url": "/api/integrations/freshdesk/accounts",
12331 "title": "Gets a list of Freshdesk Accounts",
12334 "title": "Example usage:",
12335 "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
12339 "name": "GetFreshdesk_Accounts",
12340 "group": "Freshdesk_Accounts",
12341 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12342 "version": "0.0.0",
12343 "filename": "server/api/intFreshdeskAccount/index.js",
12344 "groupTitle": "Freshdesk_Accounts"
12348 "url": "/api/integrations/freshdesk/accounts/{id}",
12349 "title": "Gets a single Freshdesk Account",
12352 "title": "Example usage:",
12353 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
12357 "name": "ShowFreshdesk_Accounts",
12358 "group": "Freshdesk_Accounts",
12359 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12360 "version": "0.0.0",
12361 "filename": "server/api/intFreshdeskAccount/index.js",
12362 "groupTitle": "Freshdesk_Accounts"
12366 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
12367 "title": "Creates new configuration",
12370 "title": "Example usage:",
12371 "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",
12375 "name": "addConfiguration",
12376 "group": "Freshdesk_Accounts",
12377 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12378 "version": "0.0.0",
12379 "filename": "server/api/intFreshdeskAccount/index.js",
12380 "groupTitle": "Freshdesk_Accounts"
12384 "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
12385 "title": "Gets account configurations",
12388 "title": "Example usage:",
12389 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12393 "name": "getConfigurations",
12394 "group": "Freshdesk_Accounts",
12395 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12396 "version": "0.0.0",
12397 "filename": "server/api/intFreshdeskAccount/index.js",
12398 "groupTitle": "Freshdesk_Accounts"
12402 "url": "/api/integrations/freshdesk/accounts/{id}/fields",
12403 "title": "Gets account fields",
12406 "title": "Example usage:",
12407 "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
12411 "name": "getFields",
12412 "group": "Freshdesk_Accounts",
12413 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12414 "version": "0.0.0",
12415 "filename": "server/api/intFreshdeskAccount/index.js",
12416 "groupTitle": "Freshdesk_Accounts"
12420 "url": "/api/integrations/freshdesk/accounts/{id}",
12421 "title": "Update an existing Freshdesk Account",
12424 "title": "Example usage:",
12425 "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",
12429 "name": "updateFreshdesk_Accounts",
12430 "group": "Freshdesk_Accounts",
12431 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12432 "version": "0.0.0",
12433 "filename": "server/api/intFreshdeskAccount/index.js",
12434 "groupTitle": "Freshdesk_Accounts"
12438 "url": "/api/integrations/freshdesk/configurations",
12439 "title": "Creates a new Freshdesk Configuration",
12442 "title": "Example usage:",
12443 "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",
12447 "name": "CreateFreshdesk_Configurations",
12448 "group": "Freshdesk_Configurations",
12463 "field": "description",
12469 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12470 "version": "0.0.0",
12471 "filename": "server/api/intFreshdeskConfiguration/index.js",
12472 "groupTitle": "Freshdesk_Configurations"
12476 "url": "/api/integrations/freshdesk/configurations/{id}",
12477 "title": "Deletes a Freshdesk Configuration",
12480 "title": "Example usage:",
12481 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
12485 "name": "DeleteFreshdesk_Configurations",
12486 "group": "Freshdesk_Configurations",
12487 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12488 "version": "0.0.0",
12489 "filename": "server/api/intFreshdeskConfiguration/index.js",
12490 "groupTitle": "Freshdesk_Configurations"
12494 "url": "/api/integrations/freshdesk/configurations",
12495 "title": "Gets a list of Freshdesk Configurations",
12498 "title": "Example usage:",
12499 "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
12503 "name": "GetFreshdesk_Configurations",
12504 "group": "Freshdesk_Configurations",
12505 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12506 "version": "0.0.0",
12507 "filename": "server/api/intFreshdeskConfiguration/index.js",
12508 "groupTitle": "Freshdesk_Configurations"
12512 "url": "/api/integrations/freshdesk/configurations/{id}",
12513 "title": "Gets a single Freshdesk Configuration",
12516 "title": "Example usage:",
12517 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
12521 "name": "ShowFreshdesk_Configurations",
12522 "group": "Freshdesk_Configurations",
12523 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12524 "version": "0.0.0",
12525 "filename": "server/api/intFreshdeskConfiguration/index.js",
12526 "groupTitle": "Freshdesk_Configurations"
12530 "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
12531 "title": "Gets configurations descriptions",
12534 "title": "Example usage:",
12535 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12539 "name": "getDescriptions",
12540 "group": "Freshdesk_Configurations",
12541 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12542 "version": "0.0.0",
12543 "filename": "server/api/intFreshdeskConfiguration/index.js",
12544 "groupTitle": "Freshdesk_Configurations"
12548 "url": "/api/integrations/freshdesk/configurations/{id}/fields",
12549 "title": "Gets configurations fields",
12552 "title": "Example usage:",
12553 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
12557 "name": "getFields",
12558 "group": "Freshdesk_Configurations",
12559 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12560 "version": "0.0.0",
12561 "filename": "server/api/intFreshdeskConfiguration/index.js",
12562 "groupTitle": "Freshdesk_Configurations"
12566 "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
12567 "title": "Gets configurations subjects",
12570 "title": "Example usage:",
12571 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12575 "name": "getSubjects",
12576 "group": "Freshdesk_Configurations",
12577 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12578 "version": "0.0.0",
12579 "filename": "server/api/intFreshdeskConfiguration/index.js",
12580 "groupTitle": "Freshdesk_Configurations"
12584 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
12585 "title": "Gets configurations tags",
12588 "title": "Example usage:",
12589 "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
12594 "group": "Freshdesk_Configurations",
12595 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12596 "version": "0.0.0",
12597 "filename": "server/api/intFreshdeskConfiguration/index.js",
12598 "groupTitle": "Freshdesk_Configurations"
12602 "url": "/api/integrations/freshdesk/configurations/{id}/tags",
12603 "title": "Sets new tags",
12606 "title": "Example usage:",
12607 "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",
12612 "group": "Freshdesk_Configurations",
12613 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12614 "version": "0.0.0",
12615 "filename": "server/api/intFreshdeskConfiguration/index.js",
12616 "groupTitle": "Freshdesk_Configurations"
12620 "url": "/api/integrations/freshdesk/configurations/{id}",
12621 "title": "Update an existing Freshdesk Configuration",
12624 "title": "Example usage:",
12625 "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",
12629 "name": "updateFreshdesk_Configurations",
12630 "group": "Freshdesk_Configurations",
12631 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12632 "version": "0.0.0",
12633 "filename": "server/api/intFreshdeskConfiguration/index.js",
12634 "groupTitle": "Freshdesk_Configurations"
12638 "url": "/api/integrations/freshdesk/fields",
12639 "title": "Creates a new Freshdesk Field",
12642 "title": "Example usage:",
12643 "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",
12647 "name": "CreateFreshdesk_Fields",
12648 "group": "Freshdesk_Fields",
12658 "\"customVariable\"",
12670 "field": "content",
12686 "\"customVariable\""
12689 "field": "keyType",
12696 "field": "keyContent",
12703 "field": "idField",
12710 "field": "nameField",
12717 "field": "customField",
12724 "field": "variableName",
12730 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12731 "version": "0.0.0",
12732 "filename": "server/api/intFreshdeskField/index.js",
12733 "groupTitle": "Freshdesk_Fields"
12737 "url": "/api/integrations/freshdesk/fields/{id}",
12738 "title": "Deletes a Freshdesk Field",
12741 "title": "Example usage:",
12742 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
12746 "name": "DeleteFreshdesk_Fields",
12747 "group": "Freshdesk_Fields",
12748 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12749 "version": "0.0.0",
12750 "filename": "server/api/intFreshdeskField/index.js",
12751 "groupTitle": "Freshdesk_Fields"
12755 "url": "/api/integrations/freshdesk/fields",
12756 "title": "Gets a list of Freshdesk Fields",
12759 "title": "Example usage:",
12760 "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
12764 "name": "GetFreshdesk_Fields",
12765 "group": "Freshdesk_Fields",
12766 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12767 "version": "0.0.0",
12768 "filename": "server/api/intFreshdeskField/index.js",
12769 "groupTitle": "Freshdesk_Fields"
12773 "url": "/api/integrations/freshdesk/fields/{id}",
12774 "title": "Gets a single Freshdesk Field",
12777 "title": "Example usage:",
12778 "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
12782 "name": "ShowFreshdesk_Fields",
12783 "group": "Freshdesk_Fields",
12784 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12785 "version": "0.0.0",
12786 "filename": "server/api/intFreshdeskField/index.js",
12787 "groupTitle": "Freshdesk_Fields"
12791 "url": "/api/integrations/freshdesk/fields/{id}",
12792 "title": "Update an existing Freshdesk Field",
12795 "title": "Example usage:",
12796 "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",
12800 "name": "updateFreshdesk_Fields",
12801 "group": "Freshdesk_Fields",
12802 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12803 "version": "0.0.0",
12804 "filename": "server/api/intFreshdeskField/index.js",
12805 "groupTitle": "Freshdesk_Fields"
12809 "url": "/api/integrations/freshsales/accounts",
12810 "title": "Creates a new Freshsales Account",
12813 "title": "Example usage:",
12814 "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",
12818 "name": "CreateFreshsales_Accounts",
12819 "group": "Freshsales_Accounts",
12834 "field": "description",
12841 "field": "username",
12855 "field": "remoteUri",
12862 "field": "serverUrl",
12868 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12869 "version": "0.0.0",
12870 "filename": "server/api/intFreshsalesAccount/index.js",
12871 "groupTitle": "Freshsales_Accounts"
12875 "url": "/api/integrations/freshsales/accounts/{id}",
12876 "title": "Deletes a Freshsales Account",
12879 "title": "Example usage:",
12880 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12884 "name": "DeleteFreshsales_Accounts",
12885 "group": "Freshsales_Accounts",
12886 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12887 "version": "0.0.0",
12888 "filename": "server/api/intFreshsalesAccount/index.js",
12889 "groupTitle": "Freshsales_Accounts"
12893 "url": "/api/integrations/freshsales/accounts",
12894 "title": "Gets a list of Freshsales Accounts",
12897 "title": "Example usage:",
12898 "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12902 "name": "GetFreshsales_Accounts",
12903 "group": "Freshsales_Accounts",
12904 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12905 "version": "0.0.0",
12906 "filename": "server/api/intFreshsalesAccount/index.js",
12907 "groupTitle": "Freshsales_Accounts"
12911 "url": "/api/integrations/freshsales/accounts/{id}",
12912 "title": "Gets a single Freshsales Account",
12915 "title": "Example usage:",
12916 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12920 "name": "ShowFreshsales_Accounts",
12921 "group": "Freshsales_Accounts",
12922 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12923 "version": "0.0.0",
12924 "filename": "server/api/intFreshsalesAccount/index.js",
12925 "groupTitle": "Freshsales_Accounts"
12929 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12930 "title": "Creates new configuration",
12933 "title": "Example usage:",
12934 "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",
12938 "name": "addConfiguration",
12939 "group": "Freshsales_Accounts",
12940 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12941 "version": "0.0.0",
12942 "filename": "server/api/intFreshsalesAccount/index.js",
12943 "groupTitle": "Freshsales_Accounts"
12947 "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12948 "title": "Gets account configurations",
12951 "title": "Example usage:",
12952 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12956 "name": "getConfigurations",
12957 "group": "Freshsales_Accounts",
12958 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12959 "version": "0.0.0",
12960 "filename": "server/api/intFreshsalesAccount/index.js",
12961 "groupTitle": "Freshsales_Accounts"
12965 "url": "/api/integrations/freshsales/accounts/{id}/fields",
12966 "title": "Gets account fields",
12969 "title": "Example usage:",
12970 "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12974 "name": "getFields",
12975 "group": "Freshsales_Accounts",
12976 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12977 "version": "0.0.0",
12978 "filename": "server/api/intFreshsalesAccount/index.js",
12979 "groupTitle": "Freshsales_Accounts"
12983 "url": "/api/integrations/freshsales/accounts/{id}",
12984 "title": "Update an existing Freshsales Account",
12987 "title": "Example usage:",
12988 "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",
12992 "name": "updateFreshsales_Accounts",
12993 "group": "Freshsales_Accounts",
12994 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12995 "version": "0.0.0",
12996 "filename": "server/api/intFreshsalesAccount/index.js",
12997 "groupTitle": "Freshsales_Accounts"
13001 "url": "/api/integrations/freshsales/configurations",
13002 "title": "Creates a new Freshsales Configuration",
13005 "title": "Example usage:",
13006 "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",
13010 "name": "CreateFreshsales_Configurations",
13011 "group": "Freshsales_Configurations",
13026 "field": "description",
13032 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13033 "version": "0.0.0",
13034 "filename": "server/api/intFreshsalesConfiguration/index.js",
13035 "groupTitle": "Freshsales_Configurations"
13039 "url": "/api/integrations/freshsales/configurations/{id}",
13040 "title": "Deletes a Freshsales Configuration",
13043 "title": "Example usage:",
13044 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
13048 "name": "DeleteFreshsales_Configurations",
13049 "group": "Freshsales_Configurations",
13050 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13051 "version": "0.0.0",
13052 "filename": "server/api/intFreshsalesConfiguration/index.js",
13053 "groupTitle": "Freshsales_Configurations"
13057 "url": "/api/integrations/freshsales/configurations",
13058 "title": "Gets a list of Freshsales Configurations",
13061 "title": "Example usage:",
13062 "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
13066 "name": "GetFreshsales_Configurations",
13067 "group": "Freshsales_Configurations",
13068 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13069 "version": "0.0.0",
13070 "filename": "server/api/intFreshsalesConfiguration/index.js",
13071 "groupTitle": "Freshsales_Configurations"
13075 "url": "/api/integrations/freshsales/configurations/{id}",
13076 "title": "Gets a single Freshsales Configuration",
13079 "title": "Example usage:",
13080 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
13084 "name": "ShowFreshsales_Configurations",
13085 "group": "Freshsales_Configurations",
13086 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13087 "version": "0.0.0",
13088 "filename": "server/api/intFreshsalesConfiguration/index.js",
13089 "groupTitle": "Freshsales_Configurations"
13093 "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
13094 "title": "Gets configurations descriptions",
13097 "title": "Example usage:",
13098 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
13102 "name": "getDescriptions",
13103 "group": "Freshsales_Configurations",
13104 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13105 "version": "0.0.0",
13106 "filename": "server/api/intFreshsalesConfiguration/index.js",
13107 "groupTitle": "Freshsales_Configurations"
13111 "url": "/api/integrations/freshsales/configurations/{id}/fields",
13112 "title": "Gets configurations fields",
13115 "title": "Example usage:",
13116 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
13120 "name": "getFields",
13121 "group": "Freshsales_Configurations",
13122 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13123 "version": "0.0.0",
13124 "filename": "server/api/intFreshsalesConfiguration/index.js",
13125 "groupTitle": "Freshsales_Configurations"
13129 "url": "/api/integrations/freshsales/configurations/{id}/subjects",
13130 "title": "Gets configurations subjects",
13133 "title": "Example usage:",
13134 "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
13138 "name": "getSubjects",
13139 "group": "Freshsales_Configurations",
13140 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13141 "version": "0.0.0",
13142 "filename": "server/api/intFreshsalesConfiguration/index.js",
13143 "groupTitle": "Freshsales_Configurations"
13147 "url": "/api/integrations/freshsales/configurations/{id}",
13148 "title": "Update an existing Freshsales Configuration",
13151 "title": "Example usage:",
13152 "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",
13156 "name": "updateFreshsales_Configurations",
13157 "group": "Freshsales_Configurations",
13158 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13159 "version": "0.0.0",
13160 "filename": "server/api/intFreshsalesConfiguration/index.js",
13161 "groupTitle": "Freshsales_Configurations"
13165 "url": "/api/integrations/freshsales/fields",
13166 "title": "Creates a new Freshsales Field",
13169 "title": "Example usage:",
13170 "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",
13174 "name": "CreateFreshsales_Fields",
13175 "group": "Freshsales_Fields",
13185 "\"customVariable\"",
13197 "field": "content",
13213 "\"customVariable\""
13216 "field": "keyType",
13223 "field": "keyContent",
13230 "field": "idField",
13237 "field": "nameField",
13244 "field": "customField",
13251 "field": "variableName",
13257 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13258 "version": "0.0.0",
13259 "filename": "server/api/intFreshsalesField/index.js",
13260 "groupTitle": "Freshsales_Fields"
13264 "url": "/api/integrations/freshsales/fields/{id}",
13265 "title": "Deletes a Freshsales Field",
13268 "title": "Example usage:",
13269 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
13273 "name": "DeleteFreshsales_Fields",
13274 "group": "Freshsales_Fields",
13275 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13276 "version": "0.0.0",
13277 "filename": "server/api/intFreshsalesField/index.js",
13278 "groupTitle": "Freshsales_Fields"
13282 "url": "/api/integrations/freshsales/fields",
13283 "title": "Gets a list of Freshsales Fields",
13286 "title": "Example usage:",
13287 "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
13291 "name": "GetFreshsales_Fields",
13292 "group": "Freshsales_Fields",
13293 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13294 "version": "0.0.0",
13295 "filename": "server/api/intFreshsalesField/index.js",
13296 "groupTitle": "Freshsales_Fields"
13300 "url": "/api/integrations/freshsales/fields/{id}",
13301 "title": "Gets a single Freshsales Field",
13304 "title": "Example usage:",
13305 "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
13309 "name": "ShowFreshsales_Fields",
13310 "group": "Freshsales_Fields",
13311 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13312 "version": "0.0.0",
13313 "filename": "server/api/intFreshsalesField/index.js",
13314 "groupTitle": "Freshsales_Fields"
13318 "url": "/api/integrations/freshsales/fields/{id}",
13319 "title": "Update an existing Freshsales Field",
13322 "title": "Example usage:",
13323 "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",
13327 "name": "updateFreshsales_Fields",
13328 "group": "Freshsales_Fields",
13329 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13330 "version": "0.0.0",
13331 "filename": "server/api/intFreshsalesField/index.js",
13332 "groupTitle": "Freshsales_Fields"
13336 "url": "/api/campaigns/{id}/blacklists",
13337 "title": "Add blacklists to an IVR campaign",
13340 "title": "Example usage:",
13341 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13345 "name": "AddBlackLists",
13346 "group": "IVR_Campaigns",
13347 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13348 "version": "0.0.0",
13349 "filename": "server/api/campaign/index.js",
13350 "groupTitle": "IVR_Campaigns"
13354 "url": "/api/campaigns/{id}/lists",
13355 "title": "Add lists to an IVR campaign",
13358 "title": "Example usage:",
13359 "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13363 "name": "AddLists",
13364 "group": "IVR_Campaigns",
13365 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13366 "version": "0.0.0",
13367 "filename": "server/api/campaign/index.js",
13368 "groupTitle": "IVR_Campaigns"
13372 "url": "/api/campaigns/clone",
13373 "title": "Clone an existing IVR Campaign",
13376 "title": "Example usage:",
13377 "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13381 "name": "CloneIVR_Campaigns",
13382 "group": "IVR_Campaigns",
13383 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13384 "version": "0.0.0",
13385 "filename": "server/api/campaign/index.js",
13386 "groupTitle": "IVR_Campaigns"
13390 "url": "/api/campaigns",
13391 "title": "Creates a new IVR Campaign",
13394 "title": "Example usage:",
13395 "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13399 "name": "CreateIVR_Campaigns",
13400 "group": "IVR_Campaigns",
13425 "field": "description",
13433 "description": "<p>Active/Disactive Campaign</p>"
13439 "field": "limitCalls",
13440 "description": "<p>Max 200 calls.</p>"
13446 "field": "dialOriginateCallerIdName",
13453 "field": "dialOriginateCallerIdNumber",
13460 "field": "dialOriginateTimeout",
13461 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
13467 "field": "dialCongestionMaxRetry",
13468 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
13474 "field": "dialCongestionRetryFrequency",
13475 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
13481 "field": "dialBusyMaxRetry",
13482 "description": "<p>#Busy Retry (min:1, max:999)</p>"
13488 "field": "dialBusyRetryFrequency",
13489 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
13495 "field": "dialNoAnswerMaxRetry",
13496 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
13502 "field": "dialNoAnswerRetryFrequency",
13503 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
13509 "field": "dialGlobalMaxRetry",
13510 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
13516 "field": "dialTimezone",
13523 "field": "dialGlobalInterval",
13535 "field": "dialCheckDuplicateType",
13542 "field": "dialAMDActive",
13543 "description": "<p>Active/Disactive AMD</p>"
13549 "field": "dialAMDInitialSilence",
13550 "description": "<p>#AMD Initial Silence</p>"
13556 "field": "dialAMDGreeting",
13557 "description": "<p>#AMD Greeting</p>"
13563 "field": "dialAMDAfterGreetingSilence",
13564 "description": "<p>#AMD After Greeting Silence</p>"
13570 "field": "dialAMDTotalAnalysisTime",
13571 "description": "<p>#AMD Total Analysis Time</p>"
13577 "field": "dialAMDMinWordLength",
13578 "description": "<p>#AMD Min Word Length</p>"
13584 "field": "dialAMDBetweenWordsSilence",
13585 "description": "<p>#AMD Between Words Silence</p>"
13591 "field": "dialAMDMaximumNumberOfWords",
13592 "description": "<p>#AMD Maximum Number Of Words</p>"
13598 "field": "dialAMDSilenceThreshold",
13599 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
13605 "field": "dialAMDMaximumWordLength",
13606 "description": "<p>#AMD Maximum Word Length</p>"
13616 "field": "dialOrderByScheduledAt",
13623 "field": "dialPrefix",
13630 "field": "dialRandomLastDigitCallerIdNumber",
13631 "description": "<p>Random Last Digit (min:1, max:15)</p>"
13637 "field": "dialCutDigit",
13638 "description": "<p>Cut Digit (min:1, max:15)</p>"
13644 "field": "dialNoSuchNumberMaxRetry",
13645 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
13651 "field": "dialNoSuchNumberRetryFrequency",
13652 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
13658 "field": "dialDropMaxRetry",
13659 "description": "<p>#Drop Retry (min:1, max:999)</p>"
13665 "field": "dialDropRetryFrequency",
13666 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
13672 "field": "dialAbandonedMaxRetry",
13673 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
13679 "field": "dialAbandonedRetryFrequency",
13680 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
13686 "field": "dialMachineMaxRetry",
13687 "description": "<p>#Machine Retry (min:1, max:999)</p>"
13693 "field": "dialMachineRetryFrequency",
13694 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
13700 "field": "dialAgentRejectMaxRetry",
13701 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
13707 "field": "dialAgentRejectRetryFrequency",
13708 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
13713 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13714 "version": "0.0.0",
13715 "filename": "server/api/campaign/index.js",
13716 "groupTitle": "IVR_Campaigns"
13720 "url": "/api/campaigns/{id}",
13721 "title": "Deletes a IVR Campaign",
13724 "title": "Example usage:",
13725 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
13729 "name": "DeleteIVR_Campaigns",
13730 "group": "IVR_Campaigns",
13731 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13732 "version": "0.0.0",
13733 "filename": "server/api/campaign/index.js",
13734 "groupTitle": "IVR_Campaigns"
13738 "url": "/api/campaigns/{id}/blacklists",
13739 "title": "Get IVR campaign blacklists",
13742 "title": "Example usage:",
13743 "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
13747 "name": "GetBlackLists",
13748 "group": "IVR_Campaigns",
13749 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13750 "version": "0.0.0",
13751 "filename": "server/api/campaign/index.js",
13752 "groupTitle": "IVR_Campaigns"
13756 "url": "/api/campaigns/{id}/finals",
13757 "title": "Gets IVR campaign hopper finals",
13760 "title": "Example usage:",
13761 "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password} -X GET",
13765 "name": "GetHopperFinals",
13766 "group": "IVR_Campaigns",
13767 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13768 "version": "0.0.0",
13769 "filename": "server/api/campaign/index.js",
13770 "groupTitle": "IVR_Campaigns"
13774 "url": "/api/campaigns/{id}/hopper_histories",
13775 "title": "Gets IVR campaign hopper histories",
13778 "title": "Example usage:",
13779 "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
13783 "name": "GetHopperHistories",
13784 "group": "IVR_Campaigns",
13785 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13786 "version": "0.0.0",
13787 "filename": "server/api/campaign/index.js",
13788 "groupTitle": "IVR_Campaigns"
13792 "url": "/api/campaigns/{id}/hoppers",
13793 "title": "Gets IVR campaign hoppers",
13796 "title": "Example usage:",
13797 "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13801 "name": "GetHoppers",
13802 "group": "IVR_Campaigns",
13803 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13804 "version": "0.0.0",
13805 "filename": "server/api/campaign/index.js",
13806 "groupTitle": "IVR_Campaigns"
13810 "url": "/api/campaigns",
13811 "title": "Gets a list of IVR Campaigns",
13814 "title": "Example usage:",
13815 "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13819 "name": "GetIVR_Campaigns",
13820 "group": "IVR_Campaigns",
13821 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13822 "version": "0.0.0",
13823 "filename": "server/api/campaign/index.js",
13824 "groupTitle": "IVR_Campaigns"
13828 "url": "/api/campaigns/{id}/lists",
13829 "title": "Get IVR campaign lists",
13832 "title": "Example usage:",
13833 "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13837 "name": "GetLists",
13838 "group": "IVR_Campaigns",
13839 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13840 "version": "0.0.0",
13841 "filename": "server/api/campaign/index.js",
13842 "groupTitle": "IVR_Campaigns"
13846 "url": "/api/campaigns/{id}/blacklists",
13847 "title": "Remove blacklists from an IVR Campaign",
13850 "title": "Example usage:",
13851 "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13855 "name": "RemoveBlackLists",
13856 "group": "IVR_Campaigns",
13857 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13858 "version": "0.0.0",
13859 "filename": "server/api/campaign/index.js",
13860 "groupTitle": "IVR_Campaigns"
13864 "url": "/api/campaigns/{id}/lists",
13865 "title": "Remove lists from an IVR Campaign",
13868 "title": "Example usage:",
13869 "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13873 "name": "RemoveLists",
13874 "group": "IVR_Campaigns",
13875 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13876 "version": "0.0.0",
13877 "filename": "server/api/campaign/index.js",
13878 "groupTitle": "IVR_Campaigns"
13882 "url": "/api/campaigns/{id}",
13883 "title": "Gets a single IVR Campaign",
13886 "title": "Example usage:",
13887 "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13891 "name": "ShowIVR_Campaigns",
13892 "group": "IVR_Campaigns",
13893 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13894 "version": "0.0.0",
13895 "filename": "server/api/campaign/index.js",
13896 "groupTitle": "IVR_Campaigns"
13900 "url": "/api/campaigns/{id}/blacks",
13901 "title": "Gets IVR campaign hopper blacks",
13904 "title": "Example usage:",
13905 "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password} -X GET",
13909 "name": "getHopperBlacks",
13910 "group": "IVR_Campaigns",
13911 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13912 "version": "0.0.0",
13913 "filename": "server/api/campaign/index.js",
13914 "groupTitle": "IVR_Campaigns"
13918 "url": "/api/campaigns/{id}",
13919 "title": "Update an existing IVR Campaign",
13922 "title": "Example usage:",
13923 "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13927 "name": "updateIVR_Campaigns",
13928 "group": "IVR_Campaigns",
13929 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13930 "version": "0.0.0",
13931 "filename": "server/api/campaign/index.js",
13932 "groupTitle": "IVR_Campaigns"
13936 "url": "/api/integrations/reports",
13937 "title": "Creates a new Integration Report",
13940 "title": "Example usage:",
13941 "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13945 "name": "CreateIntegration_Reports",
13946 "group": "Integration_Reports",
13954 "field": "integration",
13961 "field": "eventChannel",
13968 "field": "exitStatus",
13975 "field": "ticketId",
13982 "field": "integrationId",
13989 "field": "contacts",
13996 "field": "uniqueid",
14003 "field": "calleridnum",
14010 "field": "calleridname",
14024 "field": "interface",
14031 "field": "membername",
14038 "field": "agentcalledAt",
14045 "field": "agentconnectAt",
14052 "field": "holdtime",
14059 "field": "agentcomplete",
14066 "field": "agentcompleteAt",
14073 "field": "talktime",
14080 "field": "agentacw",
14087 "field": "acwtime",
14101 "field": "agentringnoanswer",
14108 "field": "agentringnoanswerAt",
14115 "field": "agentdump",
14122 "field": "agentdumpAt",
14129 "field": "lastevent",
14136 "field": "channel",
14143 "field": "channelstate",
14150 "field": "channelstatedesc",
14157 "field": "connectedlinenum",
14164 "field": "connectedlinename",
14171 "field": "language",
14178 "field": "accountcode",
14185 "field": "context",
14199 "field": "priority",
14206 "field": "destchannel",
14213 "field": "destchannelstate",
14220 "field": "destchannelstatedesc",
14227 "field": "destcalleridnum",
14234 "field": "destcalleridname",
14241 "field": "destconnectedlinenum",
14248 "field": "destconnectedlinename",
14255 "field": "destlanguage",
14262 "field": "destaccountcode",
14269 "field": "destcontext",
14276 "field": "destexten",
14283 "field": "destpriority",
14290 "field": "destuniqueid",
14297 "field": "messageId",
14304 "field": "inReplyTo",
14311 "field": "subject",
14339 "field": "attachment",
14387 "field": "appdata",
14394 "field": "projectId",
14400 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14401 "version": "0.0.0",
14402 "filename": "server/api/integrationReport/index.js",
14403 "groupTitle": "Integration_Reports"
14407 "url": "/api/integrations/reports/{id}",
14408 "title": "Deletes a Integration Report",
14411 "title": "Example usage:",
14412 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
14416 "name": "DeleteIntegration_Reports",
14417 "group": "Integration_Reports",
14418 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14419 "version": "0.0.0",
14420 "filename": "server/api/integrationReport/index.js",
14421 "groupTitle": "Integration_Reports"
14425 "url": "/api/integrations/reports/describe",
14426 "title": "Gets table info about Integration Reports",
14429 "title": "Example usage:",
14430 "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
14434 "name": "DescribeIntegration_Reports",
14435 "group": "Integration_Reports",
14436 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14437 "version": "0.0.0",
14438 "filename": "server/api/integrationReport/index.js",
14439 "groupTitle": "Integration_Reports"
14443 "url": "/api/integrations/reports",
14444 "title": "Gets a list of Integration Reports",
14447 "title": "Example usage:",
14448 "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
14452 "name": "GetIntegration_Reports",
14453 "group": "Integration_Reports",
14454 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14455 "version": "0.0.0",
14456 "filename": "server/api/integrationReport/index.js",
14457 "groupTitle": "Integration_Reports"
14461 "url": "/api/integrations/reports/{id}",
14462 "title": "Gets a single Integration Report",
14465 "title": "Example usage:",
14466 "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
14470 "name": "ShowIntegration_Reports",
14471 "group": "Integration_Reports",
14472 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14473 "version": "0.0.0",
14474 "filename": "server/api/integrationReport/index.js",
14475 "groupTitle": "Integration_Reports"
14479 "url": "/api/integrations/reports/{id}",
14480 "title": "Update an existing Integration Report",
14483 "title": "Example usage:",
14484 "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",
14488 "name": "updateIntegration_Reports",
14489 "group": "Integration_Reports",
14490 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14491 "version": "0.0.0",
14492 "filename": "server/api/integrationReport/index.js",
14493 "groupTitle": "Integration_Reports"
14497 "url": "/api/intervals",
14498 "title": "Creates a new Interval",
14501 "title": "Example usage:",
14502 "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14506 "name": "CreateIntervals",
14507 "group": "Intervals",
14522 "field": "description",
14529 "field": "interval",
14535 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14536 "version": "0.0.0",
14537 "filename": "server/api/interval/index.js",
14538 "groupTitle": "Intervals"
14542 "url": "/api/intervals/{id}",
14543 "title": "Deletes a Interval",
14546 "title": "Example usage:",
14547 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
14551 "name": "DeleteIntervals",
14552 "group": "Intervals",
14553 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14554 "version": "0.0.0",
14555 "filename": "server/api/interval/index.js",
14556 "groupTitle": "Intervals"
14560 "url": "/api/intervals",
14561 "title": "Gets a list of Intervals",
14564 "title": "Example usage:",
14565 "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
14569 "name": "GetIntervals",
14570 "group": "Intervals",
14571 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14572 "version": "0.0.0",
14573 "filename": "server/api/interval/index.js",
14574 "groupTitle": "Intervals"
14578 "url": "/api/intervals/{id}",
14579 "title": "Gets a single Interval",
14582 "title": "Example usage:",
14583 "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
14587 "name": "ShowIntervals",
14588 "group": "Intervals",
14589 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14590 "version": "0.0.0",
14591 "filename": "server/api/interval/index.js",
14592 "groupTitle": "Intervals"
14596 "url": "/api/intervals/{id}/sub_intervals",
14597 "title": "Creates a new sub interval",
14600 "title": "Example usage:",
14601 "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",
14605 "name": "addInterval",
14606 "group": "Intervals",
14607 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14608 "version": "0.0.0",
14609 "filename": "server/api/interval/index.js",
14610 "groupTitle": "Intervals"
14614 "url": "/api/intervals/{id}/sub_intervals/create_many",
14615 "title": "Create new sub intervals set",
14618 "title": "Example usage:",
14619 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14623 "name": "addIntervals",
14624 "group": "Intervals",
14625 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14626 "version": "0.0.0",
14627 "filename": "server/api/interval/index.js",
14628 "groupTitle": "Intervals"
14632 "url": "/api/intervals/{id}/sub_intervals",
14633 "title": "Get sub intervals set",
14636 "title": "Example usage:",
14637 "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
14641 "name": "getIntervals",
14642 "group": "Intervals",
14643 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14644 "version": "0.0.0",
14645 "filename": "server/api/interval/index.js",
14646 "groupTitle": "Intervals"
14650 "url": "/api/intervals/{id}",
14651 "title": "Update an existing Interval",
14654 "title": "Example usage:",
14655 "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14659 "name": "updateIntervals",
14660 "group": "Intervals",
14661 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14662 "version": "0.0.0",
14663 "filename": "server/api/interval/index.js",
14664 "groupTitle": "Intervals"
14668 "url": "/api/jira",
14669 "title": "Creates a new issue",
14672 "title": "Example usage:",
14673 "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}",
14677 "name": "Creates_Issue",
14689 "field": "issuetype",
14696 "field": "summary",
14703 "field": "description",
14709 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14710 "version": "0.0.0",
14711 "filename": "server/api/jira/index.js",
14712 "groupTitle": "Issue"
14716 "url": "/api/jscripty/answers/reports",
14717 "title": "Creates a new Report",
14720 "title": "Example usage:",
14721 "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",
14725 "name": "CreateReports",
14726 "group": "JscriptyAnswerReport",
14734 "field": "question",
14748 "field": "membername",
14755 "field": "projectname",
14769 "field": "uniqueid",
14776 "field": "calleridname",
14783 "field": "calleridnum",
14790 "field": "questionId",
14796 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14797 "version": "0.0.0",
14798 "filename": "server/api/jscriptyAnswerReport/index.js",
14799 "groupTitle": "JscriptyAnswerReport"
14803 "url": "/api/jscripty/answers/reports/{id}",
14804 "title": "Deletes a Report",
14807 "title": "Example usage:",
14808 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14812 "name": "DeleteReports",
14813 "group": "JscriptyAnswerReport",
14814 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14815 "version": "0.0.0",
14816 "filename": "server/api/jscriptyAnswerReport/index.js",
14817 "groupTitle": "JscriptyAnswerReport"
14821 "url": "/api/jscripty/answers/reports/describe",
14822 "title": "Gets table info about Reports",
14825 "title": "Example usage:",
14826 "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14830 "name": "DescribeReports",
14831 "group": "JscriptyAnswerReport",
14832 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14833 "version": "0.0.0",
14834 "filename": "server/api/jscriptyAnswerReport/index.js",
14835 "groupTitle": "JscriptyAnswerReport"
14839 "url": "/api/jscripty/answers/reports",
14840 "title": "Gets a list of Reports",
14843 "title": "Example usage:",
14844 "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14848 "name": "GetReports",
14849 "group": "JscriptyAnswerReport",
14850 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14851 "version": "0.0.0",
14852 "filename": "server/api/jscriptyAnswerReport/index.js",
14853 "groupTitle": "JscriptyAnswerReport"
14857 "url": "/api/jscripty/answers/reports/{id}",
14858 "title": "Gets a single Report",
14861 "title": "Example usage:",
14862 "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14866 "name": "ShowReports",
14867 "group": "JscriptyAnswerReport",
14868 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14869 "version": "0.0.0",
14870 "filename": "server/api/jscriptyAnswerReport/index.js",
14871 "groupTitle": "JscriptyAnswerReport"
14875 "url": "/api/jscripty/answers/reports/{id}",
14876 "title": "Update an existing Report",
14879 "title": "Example usage:",
14880 "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",
14884 "name": "updateReports",
14885 "group": "JscriptyAnswerReport",
14886 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14887 "version": "0.0.0",
14888 "filename": "server/api/jscriptyAnswerReport/index.js",
14889 "groupTitle": "JscriptyAnswerReport"
14893 "url": "/api/jscripty/questions/reports",
14894 "title": "Creates a new Report",
14897 "title": "Example usage:",
14898 "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",
14902 "name": "CreateReports",
14903 "group": "JscriptyQuestionReport",
14911 "field": "question",
14925 "field": "membername",
14932 "field": "projectname",
14946 "field": "uniqueid",
14953 "field": "calleridname",
14960 "field": "calleridnum",
14967 "field": "questionId",
14973 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14974 "version": "0.0.0",
14975 "filename": "server/api/jscriptyQuestionReport/index.js",
14976 "groupTitle": "JscriptyQuestionReport"
14980 "url": "/api/jscripty/questions/reports/{id}",
14981 "title": "Deletes a Report",
14984 "title": "Example usage:",
14985 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14989 "name": "DeleteReports",
14990 "group": "JscriptyQuestionReport",
14991 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14992 "version": "0.0.0",
14993 "filename": "server/api/jscriptyQuestionReport/index.js",
14994 "groupTitle": "JscriptyQuestionReport"
14998 "url": "/api/jscripty/questions/reports/describe",
14999 "title": "Gets table info about Reports",
15002 "title": "Example usage:",
15003 "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
15007 "name": "DescribeReports",
15008 "group": "JscriptyQuestionReport",
15009 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15010 "version": "0.0.0",
15011 "filename": "server/api/jscriptyQuestionReport/index.js",
15012 "groupTitle": "JscriptyQuestionReport"
15016 "url": "/api/jscripty/questions/reports",
15017 "title": "Gets a list of Reports",
15020 "title": "Example usage:",
15021 "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
15025 "name": "GetReports",
15026 "group": "JscriptyQuestionReport",
15027 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15028 "version": "0.0.0",
15029 "filename": "server/api/jscriptyQuestionReport/index.js",
15030 "groupTitle": "JscriptyQuestionReport"
15034 "url": "/api/jscripty/questions/reports/{id}",
15035 "title": "Gets a single Report",
15038 "title": "Example usage:",
15039 "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
15043 "name": "ShowReports",
15044 "group": "JscriptyQuestionReport",
15045 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15046 "version": "0.0.0",
15047 "filename": "server/api/jscriptyQuestionReport/index.js",
15048 "groupTitle": "JscriptyQuestionReport"
15052 "url": "/api/jscripty/questions/reports/{id}",
15053 "title": "Update an existing Report",
15056 "title": "Example usage:",
15057 "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",
15061 "name": "updateReports",
15062 "group": "JscriptyQuestionReport",
15063 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15064 "version": "0.0.0",
15065 "filename": "server/api/jscriptyQuestionReport/index.js",
15066 "groupTitle": "JscriptyQuestionReport"
15070 "url": "/api/jscripty/sessions/reports",
15071 "title": "Creates a new Report",
15074 "title": "Example usage:",
15075 "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",
15079 "name": "CreateReports",
15080 "group": "JscriptySessionReport",
15088 "field": "starttime",
15095 "field": "endtime",
15102 "field": "membername",
15109 "field": "projectname",
15123 "field": "uniqueid",
15130 "field": "calleridname",
15137 "field": "calleridnum",
15144 "field": "completed",
15150 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15151 "version": "0.0.0",
15152 "filename": "server/api/jscriptySessionReport/index.js",
15153 "groupTitle": "JscriptySessionReport"
15157 "url": "/api/jscripty/sessions/reports/{id}",
15158 "title": "Deletes a Report",
15161 "title": "Example usage:",
15162 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
15166 "name": "DeleteReports",
15167 "group": "JscriptySessionReport",
15168 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15169 "version": "0.0.0",
15170 "filename": "server/api/jscriptySessionReport/index.js",
15171 "groupTitle": "JscriptySessionReport"
15175 "url": "/api/jscripty/sessions/reports/describe",
15176 "title": "Gets table info about Reports",
15179 "title": "Example usage:",
15180 "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
15184 "name": "DescribeReports",
15185 "group": "JscriptySessionReport",
15186 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15187 "version": "0.0.0",
15188 "filename": "server/api/jscriptySessionReport/index.js",
15189 "groupTitle": "JscriptySessionReport"
15193 "url": "/api/jscripty/sessions/reports",
15194 "title": "Gets a list of Reports",
15197 "title": "Example usage:",
15198 "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
15202 "name": "GetReports",
15203 "group": "JscriptySessionReport",
15204 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15205 "version": "0.0.0",
15206 "filename": "server/api/jscriptySessionReport/index.js",
15207 "groupTitle": "JscriptySessionReport"
15211 "url": "/api/jscripty/sessions/reports/{id}",
15212 "title": "Gets a single Report",
15215 "title": "Example usage:",
15216 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
15220 "name": "ShowReports",
15221 "group": "JscriptySessionReport",
15222 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15223 "version": "0.0.0",
15224 "filename": "server/api/jscriptySessionReport/index.js",
15225 "groupTitle": "JscriptySessionReport"
15229 "url": "/api/jscripty/sessions/reports/{id}/questions",
15230 "title": "Gets Jscripty Session questions",
15233 "title": "Example usage:",
15234 "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password} -X GET",
15238 "name": "getQuestions",
15239 "group": "JscriptySessionReport",
15240 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15241 "version": "0.0.0",
15242 "filename": "server/api/jscriptySessionReport/index.js",
15243 "groupTitle": "JscriptySessionReport"
15247 "url": "/api/jscripty/sessions/reports/{id}",
15248 "title": "Update an existing Report",
15251 "title": "Example usage:",
15252 "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",
15256 "name": "updateReports",
15257 "group": "JscriptySessionReport",
15258 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15259 "version": "0.0.0",
15260 "filename": "server/api/jscriptySessionReport/index.js",
15261 "groupTitle": "JscriptySessionReport"
15265 "url": "/api/jscripty/projects/clone",
15266 "title": "Clone an existing Project",
15269 "title": "Example usage:",
15270 "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",
15274 "name": "CloneProjects",
15275 "group": "Jscripty_Projects",
15276 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15277 "version": "0.0.0",
15278 "filename": "server/api/jscriptyProject/index.js",
15279 "groupTitle": "Jscripty_Projects"
15283 "url": "/api/jscripty/projects",
15284 "title": "Creates a new Project",
15287 "title": "Example usage:",
15288 "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15292 "name": "CreateProjects",
15293 "group": "Jscripty_Projects",
15308 "field": "description",
15315 "field": "formData",
15322 "field": "enableUncompleteSave",
15329 "field": "sendUnpauseOnSubmit",
15335 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15336 "version": "0.0.0",
15337 "filename": "server/api/jscriptyProject/index.js",
15338 "groupTitle": "Jscripty_Projects"
15342 "url": "/api/jscripty/projects/{id}",
15343 "title": "Deletes a Project",
15346 "title": "Example usage:",
15347 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
15351 "name": "DeleteProjects",
15352 "group": "Jscripty_Projects",
15353 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15354 "version": "0.0.0",
15355 "filename": "server/api/jscriptyProject/index.js",
15356 "groupTitle": "Jscripty_Projects"
15360 "url": "/api/jscripty/projects",
15361 "title": "Gets a list of Projects",
15364 "title": "Example usage:",
15365 "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
15369 "name": "GetProjects",
15370 "group": "Jscripty_Projects",
15371 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15372 "version": "0.0.0",
15373 "filename": "server/api/jscriptyProject/index.js",
15374 "groupTitle": "Jscripty_Projects"
15378 "url": "/api/jscripty/projects/{id}",
15379 "title": "Gets a single Project",
15382 "title": "Example usage:",
15383 "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
15387 "name": "ShowProjects",
15388 "group": "Jscripty_Projects",
15389 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15390 "version": "0.0.0",
15391 "filename": "server/api/jscriptyProject/index.js",
15392 "groupTitle": "Jscripty_Projects"
15396 "url": "/api/jscripty/projects/{id}/answers",
15397 "title": "Gets jscripty project answers",
15400 "title": "Example usage:",
15401 "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password} -X GET",
15405 "name": "getAnswers",
15406 "group": "Jscripty_Projects",
15407 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15408 "version": "0.0.0",
15409 "filename": "server/api/jscriptyProject/index.js",
15410 "groupTitle": "Jscripty_Projects"
15414 "url": "/api/jscripty/projects/{id}/sessions",
15415 "title": "Gets jscripty project sessions",
15418 "title": "Example usage:",
15419 "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password} -X GET",
15423 "name": "getSessions",
15424 "group": "Jscripty_Projects",
15425 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15426 "version": "0.0.0",
15427 "filename": "server/api/jscriptyProject/index.js",
15428 "groupTitle": "Jscripty_Projects"
15432 "url": "/api/jscripty/projects/{id}/summary",
15433 "title": "Gets jscripty project summary",
15436 "title": "Example usage:",
15437 "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password} -X GET",
15441 "name": "getSummary",
15442 "group": "Jscripty_Projects",
15443 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15444 "version": "0.0.0",
15445 "filename": "server/api/jscriptyProject/index.js",
15446 "groupTitle": "Jscripty_Projects"
15450 "url": "/api/jscripty/projects/{id}",
15451 "title": "Update an existing Project",
15454 "title": "Example usage:",
15455 "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",
15459 "name": "updateProjects",
15460 "group": "Jscripty_Projects",
15461 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15462 "version": "0.0.0",
15463 "filename": "server/api/jscriptyProject/index.js",
15464 "groupTitle": "Jscripty_Projects"
15468 "url": "/api/license",
15469 "title": "Gets License Info",
15472 "title": "Example usage:",
15473 "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
15478 "group": "License",
15479 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15480 "version": "0.0.0",
15481 "filename": "server/api/license/index.js",
15482 "groupTitle": "License"
15486 "url": "/api/license/{id}",
15487 "title": "Update License Info",
15490 "title": "Example usage:",
15491 "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
15496 "group": "License",
15497 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15498 "version": "0.0.0",
15499 "filename": "server/api/license/index.js",
15500 "groupTitle": "License"
15504 "url": "/api/mail/accounts/{id}/users",
15505 "title": "Add agents to a mail account",
15508 "title": "Example usage:",
15509 "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",
15513 "name": "AddAgents",
15514 "group": "Mail_Accounts",
15515 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15516 "version": "0.0.0",
15517 "filename": "server/api/mailAccount/index.js",
15518 "groupTitle": "Mail_Accounts"
15522 "url": "/api/mail/accounts/{id}/in_servers",
15523 "title": "Creates a new IMAP server",
15526 "title": "Example usage:",
15527 "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",
15532 "group": "Mail_Accounts",
15540 "field": "description",
15554 "field": "authentication",
15568 "field": "password",
15589 "field": "mailbox",
15596 "field": "connTimeout",
15603 "field": "authTimeout",
15610 "field": "service",
15616 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15617 "version": "0.0.0",
15618 "filename": "server/api/mailAccount/index.js",
15619 "groupTitle": "Mail_Accounts"
15623 "url": "/api/mail/accounts/{id}/out_servers",
15624 "title": "Creates a new SMTP server",
15627 "title": "Example usage:",
15628 "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",
15633 "group": "Mail_Accounts",
15641 "field": "description",
15683 "field": "service",
15690 "field": "authentication",
15696 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15697 "version": "0.0.0",
15698 "filename": "server/api/mailAccount/index.js",
15699 "groupTitle": "Mail_Accounts"
15703 "url": "/api/mail/accounts/{id}",
15704 "title": "Deletes a mail account",
15707 "title": "Example usage:",
15708 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
15712 "name": "DeleteMailAccounts",
15713 "group": "Mail_Accounts",
15714 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15715 "version": "0.0.0",
15716 "filename": "server/api/mailAccount/index.js",
15717 "groupTitle": "Mail_Accounts"
15721 "url": "/api/mail/accounts/describe",
15722 "title": "Gets table info about Accounts",
15725 "title": "Example usage:",
15726 "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
15730 "name": "DescribeAccounts",
15731 "group": "Mail_Accounts",
15732 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15733 "version": "0.0.0",
15734 "filename": "server/api/mailAccount/index.js",
15735 "groupTitle": "Mail_Accounts"
15739 "url": "/api/mail/accounts",
15740 "title": "Gets a list of Accounts",
15743 "title": "Example usage:",
15744 "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
15748 "name": "GetAccounts",
15749 "group": "Mail_Accounts",
15750 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15751 "version": "0.0.0",
15752 "filename": "server/api/mailAccount/index.js",
15753 "groupTitle": "Mail_Accounts"
15757 "url": "/api/mail/accounts/{id}/users",
15758 "title": "Gets agents from mail account",
15761 "title": "Example usage:",
15762 "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
15766 "name": "GetAgents",
15767 "group": "Mail_Accounts",
15768 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15769 "version": "0.0.0",
15770 "filename": "server/api/mailAccount/index.js",
15771 "groupTitle": "Mail_Accounts"
15775 "url": "/api/mail/accounts/{id}/in_servers",
15776 "title": "Gets account IMAP server",
15779 "title": "Example usage:",
15780 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
15785 "group": "Mail_Accounts",
15786 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15787 "version": "0.0.0",
15788 "filename": "server/api/mailAccount/index.js",
15789 "groupTitle": "Mail_Accounts"
15793 "url": "/api/mail/accounts/{id}/out_servers",
15794 "title": "Gets account SMTP server",
15797 "title": "Example usage:",
15798 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15803 "group": "Mail_Accounts",
15804 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15805 "version": "0.0.0",
15806 "filename": "server/api/mailAccount/index.js",
15807 "groupTitle": "Mail_Accounts"
15811 "url": "/api/mail/accounts/{id}/users",
15812 "title": "Removes agents from a mail account",
15815 "title": "Example usage:",
15816 "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15820 "name": "RemoveAgents",
15821 "group": "Mail_Accounts",
15822 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15823 "version": "0.0.0",
15824 "filename": "server/api/mailAccount/index.js",
15825 "groupTitle": "Mail_Accounts"
15829 "url": "/api/mail/accounts/{id}/canned_answers",
15830 "title": "Removes canned answers from account",
15833 "title": "Example usage:",
15834 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15838 "name": "RemoveAnswers",
15839 "group": "Mail_Accounts",
15840 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15841 "version": "0.0.0",
15842 "filename": "server/api/mailAccount/index.js",
15843 "groupTitle": "Mail_Accounts"
15847 "url": "/api/mail/accounts/{id}/dispositions",
15848 "title": "Removes dispositions from account",
15851 "title": "Example usage:",
15852 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15856 "name": "RemoveDispositions",
15857 "group": "Mail_Accounts",
15858 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15859 "version": "0.0.0",
15860 "filename": "server/api/mailAccount/index.js",
15861 "groupTitle": "Mail_Accounts"
15865 "url": "/api/mail/accounts/{id}/in_servers",
15866 "title": "Removes IMAP server from an account",
15869 "title": "Example usage:",
15870 "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15874 "name": "RemoveImmap",
15875 "group": "Mail_Accounts",
15876 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15877 "version": "0.0.0",
15878 "filename": "server/api/mailAccount/index.js",
15879 "groupTitle": "Mail_Accounts"
15883 "url": "/api/mail/accounts/{id}/out_servers",
15884 "title": "Removes SMTP server from an account",
15887 "title": "Example usage:",
15888 "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15892 "name": "RemoveSmtp",
15893 "group": "Mail_Accounts",
15894 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15895 "version": "0.0.0",
15896 "filename": "server/api/mailAccount/index.js",
15897 "groupTitle": "Mail_Accounts"
15901 "url": "/api/mail/accounts/{id}",
15902 "title": "Gets a single Account",
15905 "title": "Example usage:",
15906 "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15910 "name": "ShowAccounts",
15911 "group": "Mail_Accounts",
15912 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15913 "version": "0.0.0",
15914 "filename": "server/api/mailAccount/index.js",
15915 "groupTitle": "Mail_Accounts"
15919 "url": "/api/mail/accounts/{id}/canned_answers",
15920 "title": "Creates new canned answer",
15923 "title": "Example usage:",
15924 "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",
15928 "name": "addAnswer",
15929 "group": "Mail_Accounts",
15951 "field": "description",
15964 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15965 "version": "0.0.0",
15966 "filename": "server/api/mailAccount/index.js",
15967 "groupTitle": "Mail_Accounts"
15971 "url": "/api/mail/accounts/{id}/applications",
15972 "title": "Creates new applications",
15975 "title": "Example usage:",
15976 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15980 "name": "addApplications",
15981 "group": "Mail_Accounts",
15989 "field": "priority",
16003 "field": "appdata",
16010 "field": "description",
16017 "field": "interval",
16023 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16024 "version": "0.0.0",
16025 "filename": "server/api/mailAccount/index.js",
16026 "groupTitle": "Mail_Accounts"
16030 "url": "/api/mail/accounts/{id}/dispositions",
16031 "title": "Creates new disposition",
16034 "title": "Example usage:",
16035 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16039 "name": "addDisposition",
16040 "group": "Mail_Accounts",
16067 "field": "description",
16073 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16074 "version": "0.0.0",
16075 "filename": "server/api/mailAccount/index.js",
16076 "groupTitle": "Mail_Accounts"
16080 "url": "/api/mail/accounts/{id}/interactions",
16081 "title": "Creates new interactions",
16084 "title": "Example usage:",
16085 "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",
16089 "name": "addInteraction",
16090 "group": "Mail_Accounts",
16105 "field": "closedAt",
16112 "field": "disposition",
16119 "field": "secondDisposition",
16126 "field": "thirdDisposition",
16140 "field": "inReplyTo",
16161 "field": "subject",
16175 "field": "read1stAt",
16182 "field": "substatus",
16189 "field": "substatusAt",
16200 "field": "firstMsgDirection",
16207 "field": "lastMsgAt",
16218 "field": "lastMsgDirection",
16225 "field": "autoreplyExecuted",
16231 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16232 "version": "0.0.0",
16233 "filename": "server/api/mailAccount/index.js",
16234 "groupTitle": "Mail_Accounts"
16238 "url": "/api/mail/accounts",
16239 "title": "Create a mail account",
16242 "title": "Example usage:",
16243 "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16248 "group": "Mail_Accounts",
16249 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16250 "version": "0.0.0",
16251 "filename": "server/api/mailAccount/index.js",
16252 "groupTitle": "Mail_Accounts"
16256 "url": "/api/mail/accounts/{id}/canned_answers",
16257 "title": "Gets account canned answers",
16260 "title": "Example usage:",
16261 "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
16265 "name": "getAnswers",
16266 "group": "Mail_Accounts",
16267 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16268 "version": "0.0.0",
16269 "filename": "server/api/mailAccount/index.js",
16270 "groupTitle": "Mail_Accounts"
16274 "url": "/api/mail/accounts/{id}/applications",
16275 "title": "Gets account applications",
16278 "title": "Example usage:",
16279 "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
16283 "name": "getApplications",
16284 "group": "Mail_Accounts",
16285 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16286 "version": "0.0.0",
16287 "filename": "server/api/mailAccount/index.js",
16288 "groupTitle": "Mail_Accounts"
16292 "url": "/api/mail/accounts/{id}/dispositions",
16293 "title": "Gets account dispositions",
16296 "title": "Example usage:",
16297 "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
16301 "name": "getDispositions",
16302 "group": "Mail_Accounts",
16303 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16304 "version": "0.0.0",
16305 "filename": "server/api/mailAccount/index.js",
16306 "groupTitle": "Mail_Accounts"
16310 "url": "/api/mail/accounts/{id}/interactions",
16311 "title": "Gets account interactions",
16314 "title": "Example usage:",
16315 "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
16319 "name": "getInteraction",
16320 "group": "Mail_Accounts",
16321 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16322 "version": "0.0.0",
16323 "filename": "server/api/mailAccount/index.js",
16324 "groupTitle": "Mail_Accounts"
16328 "url": "/api/mail/accounts/{id}/messages",
16329 "title": "Gets account messages",
16332 "title": "Example usage:",
16333 "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
16337 "name": "getMessages",
16338 "group": "Mail_Accounts",
16339 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16340 "version": "0.0.0",
16341 "filename": "server/api/mailAccount/index.js",
16342 "groupTitle": "Mail_Accounts"
16346 "url": "/api/mail/accounts/{id}/send",
16347 "title": "Send new mail",
16350 "title": "Example usage:",
16351 "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",
16355 "name": "sendMail",
16356 "group": "Mail_Accounts",
16357 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16358 "version": "0.0.0",
16359 "filename": "server/api/mailAccount/index.js",
16360 "groupTitle": "Mail_Accounts"
16364 "url": "/api/mail/accounts/{id}",
16365 "title": "Update an existing Account",
16368 "title": "Example usage:",
16369 "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",
16373 "name": "updateAccounts",
16374 "group": "Mail_Accounts",
16375 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16376 "version": "0.0.0",
16377 "filename": "server/api/mailAccount/index.js",
16378 "groupTitle": "Mail_Accounts"
16382 "url": "/api/mail/accounts/{id}/verify",
16383 "title": "Verify mail account",
16386 "title": "Example usage:",
16387 "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
16391 "name": "verifySmtp",
16392 "group": "Mail_Accounts",
16393 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16394 "version": "0.0.0",
16395 "filename": "server/api/mailAccount/index.js",
16396 "groupTitle": "Mail_Accounts"
16400 "url": "/api/mail/applications/{id}",
16401 "title": "Deletes a Application",
16404 "title": "Example usage:",
16405 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
16409 "name": "DeleteApplications",
16410 "group": "Mail_Applications",
16411 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16412 "version": "0.0.0",
16413 "filename": "server/api/mailApplication/index.js",
16414 "groupTitle": "Mail_Applications"
16418 "url": "/api/mail/applications/{id}",
16419 "title": "Gets a single Application",
16422 "title": "Example usage:",
16423 "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
16427 "name": "ShowApplications",
16428 "group": "Mail_Applications",
16429 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16430 "version": "0.0.0",
16431 "filename": "server/api/mailApplication/index.js",
16432 "groupTitle": "Mail_Applications"
16436 "url": "/api/mail/applications/{id}",
16437 "title": "Update an existing Application",
16440 "title": "Example usage:",
16441 "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",
16445 "name": "updateApplications",
16446 "group": "Mail_Applications",
16447 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16448 "version": "0.0.0",
16449 "filename": "server/api/mailApplication/index.js",
16450 "groupTitle": "Mail_Applications"
16454 "url": "/api/mail/interactions/{id}/tags",
16455 "title": "Add tags to the interaction",
16458 "title": "Example usage:",
16459 "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",
16464 "group": "Mail_Interactions",
16465 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16466 "version": "0.0.0",
16467 "filename": "server/api/mailInteraction/index.js",
16468 "groupTitle": "Mail_Interactions"
16472 "url": "/api/mail/interactions",
16473 "title": "Creates a new Interaction",
16476 "title": "Example usage:",
16477 "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16481 "name": "CreateInteractions",
16482 "group": "Mail_Interactions",
16497 "field": "closedAt",
16504 "field": "disposition",
16511 "field": "secondDisposition",
16518 "field": "thirdDisposition",
16532 "field": "inReplyTo",
16553 "field": "subject",
16567 "field": "read1stAt",
16574 "field": "substatus",
16581 "field": "substatusAt",
16592 "field": "firstMsgDirection",
16599 "field": "lastMsgAt",
16610 "field": "lastMsgDirection",
16617 "field": "autoreplyExecuted",
16623 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16624 "version": "0.0.0",
16625 "filename": "server/api/mailInteraction/index.js",
16626 "groupTitle": "Mail_Interactions"
16630 "url": "/api/mail/interactions/{id}",
16631 "title": "Deletes a Interaction",
16634 "title": "Example usage:",
16635 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
16639 "name": "DeleteInteractions",
16640 "group": "Mail_Interactions",
16641 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16642 "version": "0.0.0",
16643 "filename": "server/api/mailInteraction/index.js",
16644 "groupTitle": "Mail_Interactions"
16648 "url": "/api/mail/interactions/describe",
16649 "title": "Gets table info about Interactions",
16652 "title": "Example usage:",
16653 "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
16657 "name": "DescribeInteractions",
16658 "group": "Mail_Interactions",
16659 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16660 "version": "0.0.0",
16661 "filename": "server/api/mailInteraction/index.js",
16662 "groupTitle": "Mail_Interactions"
16666 "url": "/api/mail/interactions",
16667 "title": "Gets a list of Interactions",
16670 "title": "Example usage:",
16671 "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
16675 "name": "GetInteractions",
16676 "group": "Mail_Interactions",
16677 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16678 "version": "0.0.0",
16679 "filename": "server/api/mailInteraction/index.js",
16680 "groupTitle": "Mail_Interactions"
16684 "url": "/api/mail/interactions/{id}/tags",
16685 "title": "Removes tags from interaction",
16688 "title": "Example usage:",
16689 "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16693 "name": "RemoveTags",
16694 "group": "Mail_Interactions",
16695 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16696 "version": "0.0.0",
16697 "filename": "server/api/mailInteraction/index.js",
16698 "groupTitle": "Mail_Interactions"
16702 "url": "/api/mail/interactions/{id}",
16703 "title": "Gets a single Interaction",
16706 "title": "Example usage:",
16707 "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
16711 "name": "ShowInteractions",
16712 "group": "Mail_Interactions",
16713 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16714 "version": "0.0.0",
16715 "filename": "server/api/mailInteraction/index.js",
16716 "groupTitle": "Mail_Interactions"
16720 "url": "/api/mail/interactions/{id}/messages",
16721 "title": "Creates new message",
16724 "title": "Example usage:",
16725 "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",
16729 "name": "addMessage",
16730 "group": "Mail_Interactions",
16745 "field": "plainBody",
16763 "field": "direction",
16770 "field": "messageId",
16805 "field": "subject",
16840 "field": "originTo",
16847 "field": "originCc",
16858 "field": "originChannel",
16864 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16865 "version": "0.0.0",
16866 "filename": "server/api/mailInteraction/index.js",
16867 "groupTitle": "Mail_Interactions"
16871 "url": "/api/mail/interactions/{id}/download",
16872 "title": "Gets interaction",
16875 "title": "Example usage:",
16876 "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16880 "name": "download",
16881 "group": "Mail_Interactions",
16882 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16883 "version": "0.0.0",
16884 "filename": "server/api/mailInteraction/index.js",
16885 "groupTitle": "Mail_Interactions"
16889 "url": "/api/mail/interactions/{id}/messages",
16890 "title": "Gets interaction messages",
16893 "title": "Example usage:",
16894 "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16898 "name": "getMessages",
16899 "group": "Mail_Interactions",
16900 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16901 "version": "0.0.0",
16902 "filename": "server/api/mailInteraction/index.js",
16903 "groupTitle": "Mail_Interactions"
16907 "url": "/api/mail/interactions/{id}",
16908 "title": "Update an existing Interaction",
16911 "title": "Example usage:",
16912 "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",
16916 "name": "updateInteractions",
16917 "group": "Mail_Interactions",
16918 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16919 "version": "0.0.0",
16920 "filename": "server/api/mailInteraction/index.js",
16921 "groupTitle": "Mail_Interactions"
16925 "url": "/api/mail/messages/{id}",
16926 "title": "Deletes a Message",
16929 "title": "Example usage:",
16930 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16934 "name": "DeleteMessages",
16935 "group": "Mail_Messages",
16936 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16937 "version": "0.0.0",
16938 "filename": "server/api/mailMessage/index.js",
16939 "groupTitle": "Mail_Messages"
16943 "url": "/api/mail/messages/describe",
16944 "title": "Gets table info about Messages",
16947 "title": "Example usage:",
16948 "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16952 "name": "DescribeMessages",
16953 "group": "Mail_Messages",
16954 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16955 "version": "0.0.0",
16956 "filename": "server/api/mailMessage/index.js",
16957 "groupTitle": "Mail_Messages"
16961 "url": "/api/mail/messages",
16962 "title": "Gets a list of Messages",
16965 "title": "Example usage:",
16966 "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16970 "name": "GetMessages",
16971 "group": "Mail_Messages",
16972 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16973 "version": "0.0.0",
16974 "filename": "server/api/mailMessage/index.js",
16975 "groupTitle": "Mail_Messages"
16979 "url": "/api/mail/messages/{id}",
16980 "title": "Gets a single Message",
16983 "title": "Example usage:",
16984 "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16988 "name": "ShowMessages",
16989 "group": "Mail_Messages",
16990 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16991 "version": "0.0.0",
16992 "filename": "server/api/mailMessage/index.js",
16993 "groupTitle": "Mail_Messages"
16997 "url": "/api/mail/messages/{id}/accept",
16998 "title": "Accepts message",
17001 "title": "Example usage:",
17002 "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
17006 "name": "acceptMessage",
17007 "group": "Mail_Messages",
17008 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17009 "version": "0.0.0",
17010 "filename": "server/api/mailMessage/index.js",
17011 "groupTitle": "Mail_Messages"
17015 "url": "/api/mail/messages",
17016 "title": "Create a message",
17019 "title": "Example usage:",
17020 "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17024 "name": "createMessage",
17025 "group": "Mail_Messages",
17026 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17027 "version": "0.0.0",
17028 "filename": "server/api/mailMessage/index.js",
17029 "groupTitle": "Mail_Messages"
17033 "url": "/api/mail/messages/{id}/download",
17034 "title": "Gets message",
17037 "title": "Example usage:",
17038 "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
17042 "name": "download",
17043 "group": "Mail_Messages",
17044 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17045 "version": "0.0.0",
17046 "filename": "server/api/mailMessage/index.js",
17047 "groupTitle": "Mail_Messages"
17051 "url": "/api/mail/messages/{id}/reject",
17052 "title": "Rejects message",
17055 "title": "Example usage:",
17056 "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
17060 "name": "rejectMessage",
17061 "group": "Mail_Messages",
17062 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17063 "version": "0.0.0",
17064 "filename": "server/api/mailMessage/index.js",
17065 "groupTitle": "Mail_Messages"
17069 "url": "/api/mail/messages/{id}",
17070 "title": "Update an existing Message",
17073 "title": "Example usage:",
17074 "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",
17078 "name": "updateMessages",
17079 "group": "Mail_Messages",
17080 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17081 "version": "0.0.0",
17082 "filename": "server/api/mailMessage/index.js",
17083 "groupTitle": "Mail_Messages"
17087 "url": "/api/mail/reports/queue",
17088 "title": "Creates a new Mail Queue Report",
17091 "title": "Example usage:",
17092 "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",
17096 "name": "CreateMail_Queue_Reports",
17097 "group": "Mail_Queue_Reports",
17105 "field": "uniqueid",
17126 "field": "leaveAt",
17133 "field": "acceptAt",
17153 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17154 "version": "0.0.0",
17155 "filename": "server/api/mailQueueReport/index.js",
17156 "groupTitle": "Mail_Queue_Reports"
17160 "url": "/api/mail/reports/queue/{id}",
17161 "title": "Deletes a Mail Queue Report",
17164 "title": "Example usage:",
17165 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
17169 "name": "DeleteMail_Queue_Reports",
17170 "group": "Mail_Queue_Reports",
17171 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17172 "version": "0.0.0",
17173 "filename": "server/api/mailQueueReport/index.js",
17174 "groupTitle": "Mail_Queue_Reports"
17178 "url": "/api/mail/reports/queue/describe",
17179 "title": "Gets table info about Mail Queue Reports",
17182 "title": "Example usage:",
17183 "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
17187 "name": "DescribeMail_Queue_Reports",
17188 "group": "Mail_Queue_Reports",
17189 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17190 "version": "0.0.0",
17191 "filename": "server/api/mailQueueReport/index.js",
17192 "groupTitle": "Mail_Queue_Reports"
17196 "url": "/api/mail/reports/queue",
17197 "title": "Gets a list of Mail Queue Reports",
17200 "title": "Example usage:",
17201 "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
17205 "name": "GetMail_Queue_Reports",
17206 "group": "Mail_Queue_Reports",
17207 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17208 "version": "0.0.0",
17209 "filename": "server/api/mailQueueReport/index.js",
17210 "groupTitle": "Mail_Queue_Reports"
17214 "url": "/api/mail/reports/queue/{id}",
17215 "title": "Gets a single Mail Queue Report",
17218 "title": "Example usage:",
17219 "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
17223 "name": "ShowMail_Queue_Reports",
17224 "group": "Mail_Queue_Reports",
17225 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17226 "version": "0.0.0",
17227 "filename": "server/api/mailQueueReport/index.js",
17228 "groupTitle": "Mail_Queue_Reports"
17232 "url": "/api/mail/reports/queue/{id}",
17233 "title": "Update an existing Mail Queue Report",
17236 "title": "Example usage:",
17237 "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",
17241 "name": "updateMail_Queue_Reports",
17242 "group": "Mail_Queue_Reports",
17243 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17244 "version": "0.0.0",
17245 "filename": "server/api/mailQueueReport/index.js",
17246 "groupTitle": "Mail_Queue_Reports"
17250 "url": "/api/mail/queues/{id}/users",
17251 "title": "Add agents to a queue",
17254 "title": "Example usage:",
17255 "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",
17259 "name": "AddAgents",
17260 "group": "Mail_Queues",
17261 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17262 "version": "0.0.0",
17263 "filename": "server/api/mailQueue/index.js",
17264 "groupTitle": "Mail_Queues"
17268 "url": "/api/mail/queues/{id}/teams",
17269 "title": "Add teams to a queue",
17272 "title": "Example usage:",
17273 "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",
17277 "name": "AddTeams",
17278 "group": "Mail_Queues",
17279 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17280 "version": "0.0.0",
17281 "filename": "server/api/mailQueue/index.js",
17282 "groupTitle": "Mail_Queues"
17286 "url": "/api/mail/queues",
17287 "title": "Creates a new Queue",
17290 "title": "Example usage:",
17291 "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17295 "name": "CreateQueues",
17296 "group": "Mail_Queues",
17311 "field": "description",
17318 "field": "timeout",
17330 "field": "strategy",
17336 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17337 "version": "0.0.0",
17338 "filename": "server/api/mailQueue/index.js",
17339 "groupTitle": "Mail_Queues"
17343 "url": "/api/mail/queues/{id}",
17344 "title": "Deletes a Queue",
17347 "title": "Example usage:",
17348 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
17352 "name": "DeleteQueues",
17353 "group": "Mail_Queues",
17354 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17355 "version": "0.0.0",
17356 "filename": "server/api/mailQueue/index.js",
17357 "groupTitle": "Mail_Queues"
17361 "url": "/api/mail/queues/describe",
17362 "title": "Gets table info about Queues",
17365 "title": "Example usage:",
17366 "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
17370 "name": "DescribeQueues",
17371 "group": "Mail_Queues",
17372 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17373 "version": "0.0.0",
17374 "filename": "server/api/mailQueue/index.js",
17375 "groupTitle": "Mail_Queues"
17379 "url": "/api/mail/queues/{id}/users",
17380 "title": "Gets queue agents",
17383 "title": "Example usage:",
17384 "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
17388 "name": "GetAgents",
17389 "group": "Mail_Queues",
17390 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17391 "version": "0.0.0",
17392 "filename": "server/api/mailQueue/index.js",
17393 "groupTitle": "Mail_Queues"
17397 "url": "/api/mail/queues/{id}/members",
17398 "title": "GetMembers",
17401 "title": "Example usage:",
17402 "content": "curl https://{domain}/api/mail/queues/{id}/members -v -u {name}:{password}",
17406 "name": "GetMembers",
17407 "group": "Mail_Queues",
17408 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17409 "version": "0.0.0",
17410 "filename": "server/api/mailQueue/index.js",
17411 "groupTitle": "Mail_Queues"
17415 "url": "/api/mail/queues",
17416 "title": "Gets a list of Queues",
17419 "title": "Example usage:",
17420 "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
17424 "name": "GetQueues",
17425 "group": "Mail_Queues",
17426 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17427 "version": "0.0.0",
17428 "filename": "server/api/mailQueue/index.js",
17429 "groupTitle": "Mail_Queues"
17433 "url": "/api/mail/queues/{id}/teams",
17434 "title": "Gets queues list",
17437 "title": "Example usage:",
17438 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
17442 "name": "GetTeams",
17443 "group": "Mail_Queues",
17444 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17445 "version": "0.0.0",
17446 "filename": "server/api/mailQueue/index.js",
17447 "groupTitle": "Mail_Queues"
17451 "url": "/api/mail/queues/{id}/users",
17452 "title": "Removes agents from a queue",
17455 "title": "Example usage:",
17456 "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17460 "name": "RemoveAgents",
17461 "group": "Mail_Queues",
17462 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17463 "version": "0.0.0",
17464 "filename": "server/api/mailQueue/index.js",
17465 "groupTitle": "Mail_Queues"
17469 "url": "/api/mail/queues/{id}",
17470 "title": "Gets a single Queue",
17473 "title": "Example usage:",
17474 "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
17478 "name": "ShowQueues",
17479 "group": "Mail_Queues",
17480 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17481 "version": "0.0.0",
17482 "filename": "server/api/mailQueue/index.js",
17483 "groupTitle": "Mail_Queues"
17487 "url": "/api/mail/queues/{id}",
17488 "title": "Update an existing Queue",
17491 "title": "Example usage:",
17492 "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",
17496 "name": "updateQueues",
17497 "group": "Mail_Queues",
17498 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17499 "version": "0.0.0",
17500 "filename": "server/api/mailQueue/index.js",
17501 "groupTitle": "Mail_Queues"
17505 "url": "/api/mail/out_servers",
17506 "title": "Creates a new SMTP",
17509 "title": "Example usage:",
17510 "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",
17514 "name": "CreateSMTPs",
17515 "group": "Mail_SMTP",
17523 "field": "description",
17565 "field": "service",
17572 "field": "authentication",
17578 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17579 "version": "0.0.0",
17580 "filename": "server/api/mailServerOut/index.js",
17581 "groupTitle": "Mail_SMTP"
17585 "url": "/api/mail/out_servers/{id}",
17586 "title": "Deletes a SMTP",
17589 "title": "Example usage:",
17590 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
17594 "name": "DeleteSMTPs",
17595 "group": "Mail_SMTP",
17596 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17597 "version": "0.0.0",
17598 "filename": "server/api/mailServerOut/index.js",
17599 "groupTitle": "Mail_SMTP"
17603 "url": "/api/mail/out_servers",
17604 "title": "Gets a list of SMTPs",
17607 "title": "Example usage:",
17608 "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
17612 "name": "GetSMTPs",
17613 "group": "Mail_SMTP",
17614 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17615 "version": "0.0.0",
17616 "filename": "server/api/mailServerOut/index.js",
17617 "groupTitle": "Mail_SMTP"
17621 "url": "/api/mail/out_servers/{id}",
17622 "title": "Gets a single SMTP",
17625 "title": "Example usage:",
17626 "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
17630 "name": "ShowSMTPs",
17631 "group": "Mail_SMTP",
17632 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17633 "version": "0.0.0",
17634 "filename": "server/api/mailServerOut/index.js",
17635 "groupTitle": "Mail_SMTP"
17639 "url": "/api/mail/out_servers/{id}",
17640 "title": "Update an existing SMTP",
17643 "title": "Example usage:",
17644 "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",
17648 "name": "updateSMTPs",
17649 "group": "Mail_SMTP",
17650 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17651 "version": "0.0.0",
17652 "filename": "server/api/mailServerOut/index.js",
17653 "groupTitle": "Mail_SMTP"
17657 "url": "/api/mail/substatuses",
17658 "title": "Creates a new Queue",
17661 "title": "Example usage:",
17662 "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17666 "name": "CreateSubstatuses",
17667 "group": "Mail_Substatuses",
17682 "field": "description",
17688 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17689 "version": "0.0.0",
17690 "filename": "server/api/mailSubstatus/index.js",
17691 "groupTitle": "Mail_Substatuses"
17695 "url": "/api/mail/substatuses/{id}",
17696 "title": "Deletes a Queue",
17699 "title": "Example usage:",
17700 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
17704 "name": "DeleteSubstatuses",
17705 "group": "Mail_Substatuses",
17706 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17707 "version": "0.0.0",
17708 "filename": "server/api/mailSubstatus/index.js",
17709 "groupTitle": "Mail_Substatuses"
17713 "url": "/api/mail/substatuses/describe",
17714 "title": "Gets table info about Substatuses",
17717 "title": "Example usage:",
17718 "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
17722 "name": "DescribeSubstatuses",
17723 "group": "Mail_Substatuses",
17724 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17725 "version": "0.0.0",
17726 "filename": "server/api/mailSubstatus/index.js",
17727 "groupTitle": "Mail_Substatuses"
17731 "url": "/api/mail/substatuses",
17732 "title": "Gets a list of Substatuses",
17735 "title": "Example usage:",
17736 "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
17740 "name": "GetSubstatuses",
17741 "group": "Mail_Substatuses",
17742 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17743 "version": "0.0.0",
17744 "filename": "server/api/mailSubstatus/index.js",
17745 "groupTitle": "Mail_Substatuses"
17749 "url": "/api/mail/substatuses/{id}",
17750 "title": "Gets a single Queue",
17753 "title": "Example usage:",
17754 "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
17758 "name": "ShowSubstatuses",
17759 "group": "Mail_Substatuses",
17760 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17761 "version": "0.0.0",
17762 "filename": "server/api/mailSubstatus/index.js",
17763 "groupTitle": "Mail_Substatuses"
17767 "url": "/api/mail/substatuses/{id}",
17768 "title": "Update an existing Queue",
17771 "title": "Example usage:",
17772 "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",
17776 "name": "updateSubstatuses",
17777 "group": "Mail_Substatuses",
17778 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17779 "version": "0.0.0",
17780 "filename": "server/api/mailSubstatus/index.js",
17781 "groupTitle": "Mail_Substatuses"
17785 "url": "/api/mail/reports/transfer",
17786 "title": "Creates a new Mail Transfer Report",
17789 "title": "Example usage:",
17790 "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",
17794 "name": "CreateMail_Transfer_Reports",
17795 "group": "Mail_Transfer_Reports",
17803 "field": "uniqueid",
17822 "field": "transferredAt",
17828 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17829 "version": "0.0.0",
17830 "filename": "server/api/mailTransferReport/index.js",
17831 "groupTitle": "Mail_Transfer_Reports"
17835 "url": "/api/mail/reports/transfer/{id}",
17836 "title": "Deletes a Mail Transfer Report",
17839 "title": "Example usage:",
17840 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17844 "name": "DeleteMail_Transfer_Reports",
17845 "group": "Mail_Transfer_Reports",
17846 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17847 "version": "0.0.0",
17848 "filename": "server/api/mailTransferReport/index.js",
17849 "groupTitle": "Mail_Transfer_Reports"
17853 "url": "/api/mail/reports/transfer/describe",
17854 "title": "Gets table info about Mail Transfer Reports",
17857 "title": "Example usage:",
17858 "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17862 "name": "DescribeMail_Transfer_Reports",
17863 "group": "Mail_Transfer_Reports",
17864 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17865 "version": "0.0.0",
17866 "filename": "server/api/mailTransferReport/index.js",
17867 "groupTitle": "Mail_Transfer_Reports"
17871 "url": "/api/mail/reports/transfer",
17872 "title": "Gets a list of Mail Transfer Reports",
17875 "title": "Example usage:",
17876 "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17880 "name": "GetMail_Transfer_Reports",
17881 "group": "Mail_Transfer_Reports",
17882 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17883 "version": "0.0.0",
17884 "filename": "server/api/mailTransferReport/index.js",
17885 "groupTitle": "Mail_Transfer_Reports"
17889 "url": "/api/mail/reports/transfer/{id}",
17890 "title": "Gets a single Mail Transfer Report",
17893 "title": "Example usage:",
17894 "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17898 "name": "ShowMail_Transfer_Reports",
17899 "group": "Mail_Transfer_Reports",
17900 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17901 "version": "0.0.0",
17902 "filename": "server/api/mailTransferReport/index.js",
17903 "groupTitle": "Mail_Transfer_Reports"
17907 "url": "/api/mail/reports/transfer/{id}",
17908 "title": "Update an existing Mail Transfer Report",
17911 "title": "Example usage:",
17912 "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",
17916 "name": "updateMail_Transfer_Reports",
17917 "group": "Mail_Transfer_Reports",
17918 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17919 "version": "0.0.0",
17920 "filename": "server/api/mailTransferReport/index.js",
17921 "groupTitle": "Mail_Transfer_Reports"
17925 "url": "/api/members/reports/describe",
17926 "title": "Gets table info about Member Reports",
17929 "title": "Example usage:",
17930 "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17934 "name": "DescribeMember_Reports",
17935 "group": "Member_Reports",
17936 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17937 "version": "0.0.0",
17938 "filename": "server/api/memberReport/index.js",
17939 "groupTitle": "Member_Reports"
17943 "url": "/api/members/reports",
17944 "title": "Gets a list of Member Reports",
17947 "title": "Example usage:",
17948 "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17952 "name": "GetMember_Reports",
17953 "group": "Member_Reports",
17954 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17955 "version": "0.0.0",
17956 "filename": "server/api/memberReport/index.js",
17957 "groupTitle": "Member_Reports"
17961 "url": "/api/members/reports/{id}",
17962 "title": "Gets a single Member Report",
17965 "title": "Example usage:",
17966 "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17970 "name": "ShowMember_Reports",
17971 "group": "Member_Reports",
17972 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17973 "version": "0.0.0",
17974 "filename": "server/api/memberReport/index.js",
17975 "groupTitle": "Member_Reports"
17979 "url": "/api/migrations",
17980 "title": "Gets a list of Migrations",
17983 "title": "Example usage:",
17984 "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17988 "name": "GetMigrations",
17989 "group": "Migrations",
17990 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17991 "version": "0.0.0",
17992 "filename": "server/api/migration/index.js",
17993 "groupTitle": "Migrations"
17997 "url": "/api/voice/networks",
17998 "title": "Create a new network",
18001 "title": "Example usage:",
18002 "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18007 "group": "Networks",
18008 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18009 "version": "0.0.0",
18010 "filename": "server/api/network/index.js",
18011 "groupTitle": "Networks"
18015 "url": "/api/voice/networks/{id}",
18016 "title": "Deletes a network",
18019 "title": "Example usage:",
18020 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
18025 "group": "Networks",
18026 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18027 "version": "0.0.0",
18028 "filename": "server/api/network/index.js",
18029 "groupTitle": "Networks"
18033 "url": "/api/networks",
18034 "title": "Gets a list of Networks",
18037 "title": "Example usage:",
18038 "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
18042 "name": "GetNetworks",
18043 "group": "Networks",
18044 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18045 "version": "0.0.0",
18046 "filename": "server/api/network/index.js",
18047 "groupTitle": "Networks"
18051 "url": "/api/networks/{id}",
18052 "title": "Gets a single Network",
18055 "title": "Example usage:",
18056 "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
18060 "name": "ShowNetworks",
18061 "group": "Networks",
18062 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18063 "version": "0.0.0",
18064 "filename": "server/api/network/index.js",
18065 "groupTitle": "Networks"
18069 "url": "/api/voice/networks/{id}",
18070 "title": "Update an existing network",
18073 "title": "Example usage:",
18074 "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
18079 "group": "Networks",
18080 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18081 "version": "0.0.0",
18082 "filename": "server/api/network/index.js",
18083 "groupTitle": "Networks"
18087 "url": "/api/openchannel/accounts/{id}/users",
18088 "title": "Add agents to a openchannel account",
18091 "title": "Example usage:",
18092 "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",
18096 "name": "AddAgents",
18097 "group": "Openchannel_Accounts",
18098 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18099 "version": "0.0.0",
18100 "filename": "server/api/openchannelAccount/index.js",
18101 "groupTitle": "Openchannel_Accounts"
18105 "url": "/api/openchannel/accounts",
18106 "title": "Creates a new Account",
18109 "title": "Example usage:",
18110 "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18114 "name": "CreateAccounts",
18115 "group": "Openchannel_Accounts",
18130 "field": "description",
18144 "field": "replyUri",
18158 "field": "notificationTemplate",
18165 "field": "notificationSound",
18172 "field": "notificationShake",
18179 "field": "waitForTheAssignedAgent",
18193 "field": "queueTransfer",
18200 "field": "queueTransferTimeout",
18207 "field": "agentTransfer",
18214 "field": "agentTransferTimeout",
18221 "field": "mandatoryDispositionPauseId",
18222 "description": "<p>Status to put when mandatory disposition is enabled</p>"
18228 "field": "mandatoryDisposition",
18229 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
18234 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18235 "version": "0.0.0",
18236 "filename": "server/api/openchannelAccount/index.js",
18237 "groupTitle": "Openchannel_Accounts"
18241 "url": "/api/openchannel/accounts/{id}",
18242 "title": "Deletes a Account",
18245 "title": "Example usage:",
18246 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
18250 "name": "DeleteAccounts",
18251 "group": "Openchannel_Accounts",
18252 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18253 "version": "0.0.0",
18254 "filename": "server/api/openchannelAccount/index.js",
18255 "groupTitle": "Openchannel_Accounts"
18259 "url": "/api/openchannel/accounts/describe",
18260 "title": "Gets table info about Accounts",
18263 "title": "Example usage:",
18264 "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
18268 "name": "DescribeAccounts",
18269 "group": "Openchannel_Accounts",
18270 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18271 "version": "0.0.0",
18272 "filename": "server/api/openchannelAccount/index.js",
18273 "groupTitle": "Openchannel_Accounts"
18277 "url": "/api/openchannel/accounts",
18278 "title": "Gets a list of Accounts",
18281 "title": "Example usage:",
18282 "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
18286 "name": "GetAccounts",
18287 "group": "Openchannel_Accounts",
18288 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18289 "version": "0.0.0",
18290 "filename": "server/api/openchannelAccount/index.js",
18291 "groupTitle": "Openchannel_Accounts"
18295 "url": "/api/openchannel/accounts/{id}/users",
18296 "title": "Gets agents from openchannel account",
18299 "title": "Example usage:",
18300 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
18304 "name": "GetAgents",
18305 "group": "Openchannel_Accounts",
18306 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18307 "version": "0.0.0",
18308 "filename": "server/api/openchannelAccount/index.js",
18309 "groupTitle": "Openchannel_Accounts"
18313 "url": "/api/openchannel/accounts/{id}/users",
18314 "title": "Removes agents from a openchannel account",
18317 "title": "Example usage:",
18318 "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18322 "name": "RemoveAgents",
18323 "group": "Openchannel_Accounts",
18324 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18325 "version": "0.0.0",
18326 "filename": "server/api/openchannelAccount/index.js",
18327 "groupTitle": "Openchannel_Accounts"
18331 "url": "/api/openchannel/accounts/{id}/canned_answers",
18332 "title": "Removes canned answers from account",
18335 "title": "Example usage:",
18336 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18340 "name": "RemoveAnswers",
18341 "group": "Openchannel_Accounts",
18342 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18343 "version": "0.0.0",
18344 "filename": "server/api/openchannelAccount/index.js",
18345 "groupTitle": "Openchannel_Accounts"
18349 "url": "/api/openchannel/accounts/{id}/dispositions",
18350 "title": "Removes dispositions from account",
18353 "title": "Example usage:",
18354 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18358 "name": "RemoveDispositions",
18359 "group": "Openchannel_Accounts",
18360 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18361 "version": "0.0.0",
18362 "filename": "server/api/openchannelAccount/index.js",
18363 "groupTitle": "Openchannel_Accounts"
18367 "url": "/api/openchannel/accounts/{id}",
18368 "title": "Gets a single Account",
18371 "title": "Example usage:",
18372 "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
18376 "name": "ShowAccounts",
18377 "group": "Openchannel_Accounts",
18378 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18379 "version": "0.0.0",
18380 "filename": "server/api/openchannelAccount/index.js",
18381 "groupTitle": "Openchannel_Accounts"
18385 "url": "/api/openchannel/accounts/{id}/canned_answers",
18386 "title": "Creates new canned answer",
18389 "title": "Example usage:",
18390 "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",
18394 "name": "addAnswer",
18395 "group": "Openchannel_Accounts",
18417 "field": "description",
18430 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18431 "version": "0.0.0",
18432 "filename": "server/api/openchannelAccount/index.js",
18433 "groupTitle": "Openchannel_Accounts"
18437 "url": "/api/openchannel/accounts/{id}/applications",
18438 "title": "Creates new applications",
18441 "title": "Example usage:",
18442 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18446 "name": "addApplications",
18447 "group": "Openchannel_Accounts",
18455 "field": "priority",
18469 "field": "appdata",
18476 "field": "description",
18483 "field": "interval",
18489 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18490 "version": "0.0.0",
18491 "filename": "server/api/openchannelAccount/index.js",
18492 "groupTitle": "Openchannel_Accounts"
18496 "url": "/api/openchannel/accounts/{id}/dispositions",
18497 "title": "Creates new disposition",
18500 "title": "Example usage:",
18501 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18505 "name": "addDisposition",
18506 "group": "Openchannel_Accounts",
18533 "field": "description",
18539 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18540 "version": "0.0.0",
18541 "filename": "server/api/openchannelAccount/index.js",
18542 "groupTitle": "Openchannel_Accounts"
18546 "url": "/api/openchannel/accounts/{id}/canned_answers",
18547 "title": "Gets account canned answers",
18550 "title": "Example usage:",
18551 "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
18555 "name": "getAnswers",
18556 "group": "Openchannel_Accounts",
18557 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18558 "version": "0.0.0",
18559 "filename": "server/api/openchannelAccount/index.js",
18560 "groupTitle": "Openchannel_Accounts"
18564 "url": "/api/openchannel/accounts/{id}/applications",
18565 "title": "Gets account applications",
18568 "title": "Example usage:",
18569 "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
18573 "name": "getApplications",
18574 "group": "Openchannel_Accounts",
18575 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18576 "version": "0.0.0",
18577 "filename": "server/api/openchannelAccount/index.js",
18578 "groupTitle": "Openchannel_Accounts"
18582 "url": "/api/openchannel/accounts/{id}/dispositions",
18583 "title": "Gets account dispositions",
18586 "title": "Example usage:",
18587 "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
18591 "name": "getDispositions",
18592 "group": "Openchannel_Accounts",
18593 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18594 "version": "0.0.0",
18595 "filename": "server/api/openchannelAccount/index.js",
18596 "groupTitle": "Openchannel_Accounts"
18600 "url": "/api/openchannel/accounts/{id}/interactions",
18601 "title": "Gets Openchannel Account Interactions",
18604 "title": "Example usage:",
18605 "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
18609 "name": "getInteractions",
18610 "group": "Openchannel_Accounts",
18611 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18612 "version": "0.0.0",
18613 "filename": "server/api/openchannelAccount/index.js",
18614 "groupTitle": "Openchannel_Accounts"
18618 "url": "/api/openchannel/accounts/{id}/notify",
18619 "title": "Notify new message",
18622 "title": "Example usage:",
18623 "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",
18628 "group": "Openchannel_Accounts",
18629 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>Follow this link to check the documentation: <pre><a target=\"_blank\" href=\"https://wiki.xcallymotion.com/display/XMV/New+Channels+Configuration+Steps#NewChannelsConfigurationSteps-BuildyourownChannelservice\">https://wiki.xcallymotion.com/display/XMV/New+Channels+Configuration+Steps#NewChannelsConfigurationSteps-BuildyourownChannelservice</a></pre></p>",
18630 "version": "0.0.0",
18631 "filename": "server/api/openchannelAccount/index.js",
18632 "groupTitle": "Openchannel_Accounts"
18636 "url": "/api/openchannel/accounts/{id}/send",
18637 "title": "Send new openchannel message",
18640 "title": "Example usage:",
18641 "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",
18645 "name": "sendOpenchannel",
18646 "group": "Openchannel_Accounts",
18647 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18648 "version": "0.0.0",
18649 "filename": "server/api/openchannelAccount/index.js",
18650 "groupTitle": "Openchannel_Accounts"
18654 "url": "/api/openchannel/accounts/{id}",
18655 "title": "Update an existing Account",
18658 "title": "Example usage:",
18659 "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",
18663 "name": "updateAccounts",
18664 "group": "Openchannel_Accounts",
18665 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18666 "version": "0.0.0",
18667 "filename": "server/api/openchannelAccount/index.js",
18668 "groupTitle": "Openchannel_Accounts"
18672 "url": "/api/openchannel/applications",
18673 "title": "Creates a new Application",
18676 "title": "Example usage:",
18677 "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18681 "name": "CreateApplications",
18682 "group": "Openchannel_Applications",
18690 "field": "priority",
18704 "field": "appdata",
18711 "field": "description",
18718 "field": "interval",
18724 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18725 "version": "0.0.0",
18726 "filename": "server/api/openchannelApplication/index.js",
18727 "groupTitle": "Openchannel_Applications"
18731 "url": "/api/openchannel/applications/{id}",
18732 "title": "Deletes a Application",
18735 "title": "Example usage:",
18736 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
18740 "name": "DeleteApplications",
18741 "group": "Openchannel_Applications",
18742 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18743 "version": "0.0.0",
18744 "filename": "server/api/openchannelApplication/index.js",
18745 "groupTitle": "Openchannel_Applications"
18749 "url": "/api/openchannel/applications",
18750 "title": "Gets a list of Applications",
18753 "title": "Example usage:",
18754 "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
18758 "name": "GetApplications",
18759 "group": "Openchannel_Applications",
18760 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18761 "version": "0.0.0",
18762 "filename": "server/api/openchannelApplication/index.js",
18763 "groupTitle": "Openchannel_Applications"
18767 "url": "/api/openchannel/applications/{id}",
18768 "title": "Gets a single Application",
18771 "title": "Example usage:",
18772 "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
18776 "name": "ShowApplications",
18777 "group": "Openchannel_Applications",
18778 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18779 "version": "0.0.0",
18780 "filename": "server/api/openchannelApplication/index.js",
18781 "groupTitle": "Openchannel_Applications"
18785 "url": "/api/openchannel/applications/{id}",
18786 "title": "Update an existing Application",
18789 "title": "Example usage:",
18790 "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",
18794 "name": "updateApplications",
18795 "group": "Openchannel_Applications",
18796 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18797 "version": "0.0.0",
18798 "filename": "server/api/openchannelApplication/index.js",
18799 "groupTitle": "Openchannel_Applications"
18803 "url": "/api/openchannel/interactions/{id}/tags",
18804 "title": "Add tags to the interaction",
18807 "title": "Example usage:",
18808 "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",
18813 "group": "Openchannel_Interactions",
18814 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18815 "version": "0.0.0",
18816 "filename": "server/api/openchannelInteraction/index.js",
18817 "groupTitle": "Openchannel_Interactions"
18821 "url": "/api/openchannel/interactions",
18822 "title": "Creates a new Interaction",
18825 "title": "Example usage:",
18826 "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18830 "name": "CreateInteractions",
18831 "group": "Openchannel_Interactions",
18846 "field": "closedAt",
18853 "field": "disposition",
18860 "field": "secondDisposition",
18867 "field": "thirdDisposition",
18881 "field": "read1stAt",
18888 "field": "threadId",
18895 "field": "externalUrl",
18902 "field": "lastMsgAt",
18913 "field": "lastMsgDirection",
18927 "field": "autoreplyExecuted",
18933 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18934 "version": "0.0.0",
18935 "filename": "server/api/openchannelInteraction/index.js",
18936 "groupTitle": "Openchannel_Interactions"
18940 "url": "/api/openchannel/interactions/{id}",
18941 "title": "Deletes a Interaction",
18944 "title": "Example usage:",
18945 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18949 "name": "DeleteInteractions",
18950 "group": "Openchannel_Interactions",
18951 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18952 "version": "0.0.0",
18953 "filename": "server/api/openchannelInteraction/index.js",
18954 "groupTitle": "Openchannel_Interactions"
18958 "url": "/api/openchannel/interactions/describe",
18959 "title": "Gets table info about Interactions",
18962 "title": "Example usage:",
18963 "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18967 "name": "DescribeInteractions",
18968 "group": "Openchannel_Interactions",
18969 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18970 "version": "0.0.0",
18971 "filename": "server/api/openchannelInteraction/index.js",
18972 "groupTitle": "Openchannel_Interactions"
18976 "url": "/api/openchannel/interactions",
18977 "title": "Gets a list of Interactions",
18980 "title": "Example usage:",
18981 "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18985 "name": "GetInteractions",
18986 "group": "Openchannel_Interactions",
18987 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18988 "version": "0.0.0",
18989 "filename": "server/api/openchannelInteraction/index.js",
18990 "groupTitle": "Openchannel_Interactions"
18994 "url": "/api/openchannel/interactions/{id}/tags",
18995 "title": "Removes tags from interaction",
18998 "title": "Example usage:",
18999 "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19003 "name": "RemoveTags",
19004 "group": "Openchannel_Interactions",
19005 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19006 "version": "0.0.0",
19007 "filename": "server/api/openchannelInteraction/index.js",
19008 "groupTitle": "Openchannel_Interactions"
19012 "url": "/api/openchannel/interactions/{id}",
19013 "title": "Gets a single Interaction",
19016 "title": "Example usage:",
19017 "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
19021 "name": "ShowInteractions",
19022 "group": "Openchannel_Interactions",
19023 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19024 "version": "0.0.0",
19025 "filename": "server/api/openchannelInteraction/index.js",
19026 "groupTitle": "Openchannel_Interactions"
19030 "url": "/api/openchannel/interactions/{id}/messages",
19031 "title": "Creates new messages",
19034 "title": "Example usage:",
19035 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
19039 "name": "addMessage",
19040 "group": "Openchannel_Interactions",
19073 "field": "direction",
19087 "field": "providerName",
19094 "field": "providerResponse",
19100 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19101 "version": "0.0.0",
19102 "filename": "server/api/openchannelInteraction/index.js",
19103 "groupTitle": "Openchannel_Interactions"
19107 "url": "/api/openchannel/interactions/{id}/download",
19108 "title": "Gets interaction",
19111 "title": "Example usage:",
19112 "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
19116 "name": "download",
19117 "group": "Openchannel_Interactions",
19118 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19119 "version": "0.0.0",
19120 "filename": "server/api/openchannelInteraction/index.js",
19121 "groupTitle": "Openchannel_Interactions"
19125 "url": "/api/openchannel/interactions/{id}/messages",
19126 "title": "Gets interaction messages",
19129 "title": "Example usage:",
19130 "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
19134 "name": "getMessages",
19135 "group": "Openchannel_Interactions",
19136 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19137 "version": "0.0.0",
19138 "filename": "server/api/openchannelInteraction/index.js",
19139 "groupTitle": "Openchannel_Interactions"
19143 "url": "/api/openchannel/interactions/{id}",
19144 "title": "Update an existing Interaction",
19147 "title": "Example usage:",
19148 "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",
19152 "name": "updateInteractions",
19153 "group": "Openchannel_Interactions",
19154 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19155 "version": "0.0.0",
19156 "filename": "server/api/openchannelInteraction/index.js",
19157 "groupTitle": "Openchannel_Interactions"
19161 "url": "/api/openchannel/messages",
19162 "title": "Creates a new Message",
19165 "title": "Example usage:",
19166 "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19170 "name": "CreateMessages",
19171 "group": "Openchannel_Messages",
19204 "field": "direction",
19218 "field": "providerName",
19225 "field": "providerResponse",
19231 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19232 "version": "0.0.0",
19233 "filename": "server/api/openchannelMessage/index.js",
19234 "groupTitle": "Openchannel_Messages"
19238 "url": "/api/openchannel/messages/{id}",
19239 "title": "Deletes a Message",
19242 "title": "Example usage:",
19243 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
19247 "name": "DeleteMessages",
19248 "group": "Openchannel_Messages",
19249 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19250 "version": "0.0.0",
19251 "filename": "server/api/openchannelMessage/index.js",
19252 "groupTitle": "Openchannel_Messages"
19256 "url": "/api/openchannel/messages/describe",
19257 "title": "Gets table info about Messages",
19260 "title": "Example usage:",
19261 "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
19265 "name": "DescribeMessages",
19266 "group": "Openchannel_Messages",
19267 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19268 "version": "0.0.0",
19269 "filename": "server/api/openchannelMessage/index.js",
19270 "groupTitle": "Openchannel_Messages"
19274 "url": "/api/openchannel/messages",
19275 "title": "Gets a list of Messages",
19278 "title": "Example usage:",
19279 "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
19283 "name": "GetMessages",
19284 "group": "Openchannel_Messages",
19285 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19286 "version": "0.0.0",
19287 "filename": "server/api/openchannelMessage/index.js",
19288 "groupTitle": "Openchannel_Messages"
19292 "url": "/api/openchannel/messages/{id}",
19293 "title": "Gets a single Message",
19296 "title": "Example usage:",
19297 "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
19301 "name": "ShowMessages",
19302 "group": "Openchannel_Messages",
19303 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19304 "version": "0.0.0",
19305 "filename": "server/api/openchannelMessage/index.js",
19306 "groupTitle": "Openchannel_Messages"
19310 "url": "/api/openchannel/messages/{id}/accept",
19311 "title": "Accepts message",
19314 "title": "Example usage:",
19315 "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
19319 "name": "acceptMessage",
19320 "group": "Openchannel_Messages",
19321 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19322 "version": "0.0.0",
19323 "filename": "server/api/openchannelMessage/index.js",
19324 "groupTitle": "Openchannel_Messages"
19328 "url": "/api/openchannel/messages/{id}/reject",
19329 "title": "Rejects message",
19332 "title": "Example usage:",
19333 "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
19337 "name": "rejectMessage",
19338 "group": "Openchannel_Messages",
19339 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19340 "version": "0.0.0",
19341 "filename": "server/api/openchannelMessage/index.js",
19342 "groupTitle": "Openchannel_Messages"
19346 "url": "/api/openchannel/messages/{id}",
19347 "title": "Update an existing Message",
19350 "title": "Example usage:",
19351 "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",
19355 "name": "updateMessages",
19356 "group": "Openchannel_Messages",
19357 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19358 "version": "0.0.0",
19359 "filename": "server/api/openchannelMessage/index.js",
19360 "groupTitle": "Openchannel_Messages"
19364 "url": "/api/openchannel/reports/queue",
19365 "title": "Creates a new Openchannel Queue Report",
19368 "title": "Example usage:",
19369 "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",
19373 "name": "CreateOpenchannel_Queue_Reports",
19374 "group": "Openchannel_Queue_Reports",
19382 "field": "uniqueid",
19403 "field": "leaveAt",
19410 "field": "acceptAt",
19430 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19431 "version": "0.0.0",
19432 "filename": "server/api/openchannelQueueReport/index.js",
19433 "groupTitle": "Openchannel_Queue_Reports"
19437 "url": "/api/openchannel/reports/queue/{id}",
19438 "title": "Deletes a Openchannel Queue Report",
19441 "title": "Example usage:",
19442 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
19446 "name": "DeleteOpenchannel_Queue_Reports",
19447 "group": "Openchannel_Queue_Reports",
19448 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19449 "version": "0.0.0",
19450 "filename": "server/api/openchannelQueueReport/index.js",
19451 "groupTitle": "Openchannel_Queue_Reports"
19455 "url": "/api/openchannel/reports/queue/describe",
19456 "title": "Gets table info about Openchannel Queue Reports",
19459 "title": "Example usage:",
19460 "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
19464 "name": "DescribeOpenchannel_Queue_Reports",
19465 "group": "Openchannel_Queue_Reports",
19466 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19467 "version": "0.0.0",
19468 "filename": "server/api/openchannelQueueReport/index.js",
19469 "groupTitle": "Openchannel_Queue_Reports"
19473 "url": "/api/openchannel/reports/queue",
19474 "title": "Gets a list of Openchannel Queue Reports",
19477 "title": "Example usage:",
19478 "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
19482 "name": "GetOpenchannel_Queue_Reports",
19483 "group": "Openchannel_Queue_Reports",
19484 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19485 "version": "0.0.0",
19486 "filename": "server/api/openchannelQueueReport/index.js",
19487 "groupTitle": "Openchannel_Queue_Reports"
19491 "url": "/api/openchannel/reports/queue/{id}",
19492 "title": "Gets a single Openchannel Queue Report",
19495 "title": "Example usage:",
19496 "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
19500 "name": "ShowOpenchannel_Queue_Reports",
19501 "group": "Openchannel_Queue_Reports",
19502 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19503 "version": "0.0.0",
19504 "filename": "server/api/openchannelQueueReport/index.js",
19505 "groupTitle": "Openchannel_Queue_Reports"
19509 "url": "/api/openchannel/reports/queue/{id}",
19510 "title": "Update an existing Openchannel Queue Report",
19513 "title": "Example usage:",
19514 "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",
19518 "name": "updateOpenchannel_Queue_Reports",
19519 "group": "Openchannel_Queue_Reports",
19520 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19521 "version": "0.0.0",
19522 "filename": "server/api/openchannelQueueReport/index.js",
19523 "groupTitle": "Openchannel_Queue_Reports"
19527 "url": "/api/openchannel/queues/{id}/users",
19528 "title": "Add agents to a queue",
19531 "title": "Example usage:",
19532 "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",
19536 "name": "AddAgents",
19537 "group": "Openchannel_Queues",
19538 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19539 "version": "0.0.0",
19540 "filename": "server/api/openchannelQueue/index.js",
19541 "groupTitle": "Openchannel_Queues"
19545 "url": "/api/openchannel/queues/{id}/teams",
19546 "title": "Add teams to a queue",
19549 "title": "Example usage:",
19550 "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",
19554 "name": "AddTeams",
19555 "group": "Openchannel_Queues",
19556 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19557 "version": "0.0.0",
19558 "filename": "server/api/openchannelQueue/index.js",
19559 "groupTitle": "Openchannel_Queues"
19563 "url": "/api/openchannel/queues",
19564 "title": "Creates a new Queue",
19567 "title": "Example usage:",
19568 "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19572 "name": "CreateQueues",
19573 "group": "Openchannel_Queues",
19588 "field": "description",
19595 "field": "timeout",
19607 "field": "strategy",
19613 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19614 "version": "0.0.0",
19615 "filename": "server/api/openchannelQueue/index.js",
19616 "groupTitle": "Openchannel_Queues"
19620 "url": "/api/openchannel/queues/{id}",
19621 "title": "Deletes a Queue",
19624 "title": "Example usage:",
19625 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
19629 "name": "DeleteQueues",
19630 "group": "Openchannel_Queues",
19631 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19632 "version": "0.0.0",
19633 "filename": "server/api/openchannelQueue/index.js",
19634 "groupTitle": "Openchannel_Queues"
19638 "url": "/api/openchannel/queues/describe",
19639 "title": "Gets table info about Queues",
19642 "title": "Example usage:",
19643 "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
19647 "name": "DescribeQueues",
19648 "group": "Openchannel_Queues",
19649 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19650 "version": "0.0.0",
19651 "filename": "server/api/openchannelQueue/index.js",
19652 "groupTitle": "Openchannel_Queues"
19656 "url": "/api/openchannel/queues/{id}/users",
19657 "title": "Gets queue agents",
19660 "title": "Example usage:",
19661 "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
19665 "name": "GetAgents",
19666 "group": "Openchannel_Queues",
19667 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19668 "version": "0.0.0",
19669 "filename": "server/api/openchannelQueue/index.js",
19670 "groupTitle": "Openchannel_Queues"
19674 "url": "/api/openchannel/queues/{id}/members",
19675 "title": "GetMembers",
19678 "title": "Example usage:",
19679 "content": "curl https://{domain}/api/openchannel/queues/{id}/members -v -u {name}:{password}",
19683 "name": "GetMembers",
19684 "group": "Openchannel_Queues",
19685 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19686 "version": "0.0.0",
19687 "filename": "server/api/openchannelQueue/index.js",
19688 "groupTitle": "Openchannel_Queues"
19692 "url": "/api/openchannel/queues",
19693 "title": "Gets a list of Queues",
19696 "title": "Example usage:",
19697 "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
19701 "name": "GetQueues",
19702 "group": "Openchannel_Queues",
19703 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19704 "version": "0.0.0",
19705 "filename": "server/api/openchannelQueue/index.js",
19706 "groupTitle": "Openchannel_Queues"
19710 "url": "/api/openchannel/queues/{id}/teams",
19711 "title": "Gets queues list",
19714 "title": "Example usage:",
19715 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
19719 "name": "GetTeams",
19720 "group": "Openchannel_Queues",
19721 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19722 "version": "0.0.0",
19723 "filename": "server/api/openchannelQueue/index.js",
19724 "groupTitle": "Openchannel_Queues"
19728 "url": "/api/openchannel/queues/{id}/users",
19729 "title": "Removes agents from a queue",
19732 "title": "Example usage:",
19733 "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19737 "name": "RemoveAgents",
19738 "group": "Openchannel_Queues",
19739 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19740 "version": "0.0.0",
19741 "filename": "server/api/openchannelQueue/index.js",
19742 "groupTitle": "Openchannel_Queues"
19746 "url": "/api/openchannel/queues/{id}",
19747 "title": "Gets a single Queue",
19750 "title": "Example usage:",
19751 "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
19755 "name": "ShowQueues",
19756 "group": "Openchannel_Queues",
19757 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19758 "version": "0.0.0",
19759 "filename": "server/api/openchannelQueue/index.js",
19760 "groupTitle": "Openchannel_Queues"
19764 "url": "/api/openchannel/queues/{id}",
19765 "title": "Update an existing Queue",
19768 "title": "Example usage:",
19769 "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",
19773 "name": "updateQueues",
19774 "group": "Openchannel_Queues",
19775 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19776 "version": "0.0.0",
19777 "filename": "server/api/openchannelQueue/index.js",
19778 "groupTitle": "Openchannel_Queues"
19782 "url": "/api/openchannel/reports/transfer",
19783 "title": "Creates a new Openchannel Transfer Report",
19786 "title": "Example usage:",
19787 "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",
19791 "name": "CreateOpenchannel_Transfer_Reports",
19792 "group": "Openchannel_Transfer_Reports",
19800 "field": "uniqueid",
19819 "field": "transferredAt",
19825 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19826 "version": "0.0.0",
19827 "filename": "server/api/openchannelTransferReport/index.js",
19828 "groupTitle": "Openchannel_Transfer_Reports"
19832 "url": "/api/openchannel/reports/transfer/{id}",
19833 "title": "Deletes a Openchannel Transfer Report",
19836 "title": "Example usage:",
19837 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19841 "name": "DeleteOpenchannel_Transfer_Reports",
19842 "group": "Openchannel_Transfer_Reports",
19843 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19844 "version": "0.0.0",
19845 "filename": "server/api/openchannelTransferReport/index.js",
19846 "groupTitle": "Openchannel_Transfer_Reports"
19850 "url": "/api/openchannel/reports/transfer/describe",
19851 "title": "Gets table info about Openchannel Transfer Reports",
19854 "title": "Example usage:",
19855 "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19859 "name": "DescribeOpenchannel_Transfer_Reports",
19860 "group": "Openchannel_Transfer_Reports",
19861 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19862 "version": "0.0.0",
19863 "filename": "server/api/openchannelTransferReport/index.js",
19864 "groupTitle": "Openchannel_Transfer_Reports"
19868 "url": "/api/openchannel/reports/transfer",
19869 "title": "Gets a list of Openchannel Transfer Reports",
19872 "title": "Example usage:",
19873 "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19877 "name": "GetOpenchannel_Transfer_Reports",
19878 "group": "Openchannel_Transfer_Reports",
19879 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19880 "version": "0.0.0",
19881 "filename": "server/api/openchannelTransferReport/index.js",
19882 "groupTitle": "Openchannel_Transfer_Reports"
19886 "url": "/api/openchannel/reports/transfer/{id}",
19887 "title": "Gets a single Openchannel Transfer Report",
19890 "title": "Example usage:",
19891 "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19895 "name": "ShowOpenchannel_Transfer_Reports",
19896 "group": "Openchannel_Transfer_Reports",
19897 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19898 "version": "0.0.0",
19899 "filename": "server/api/openchannelTransferReport/index.js",
19900 "groupTitle": "Openchannel_Transfer_Reports"
19904 "url": "/api/openchannel/reports/transfer/{id}",
19905 "title": "Update an existing Openchannel Transfer Report",
19908 "title": "Example usage:",
19909 "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",
19913 "name": "updateOpenchannel_Transfer_Reports",
19914 "group": "Openchannel_Transfer_Reports",
19915 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19916 "version": "0.0.0",
19917 "filename": "server/api/openchannelTransferReport/index.js",
19918 "groupTitle": "Openchannel_Transfer_Reports"
19922 "url": "/api/pauses",
19923 "title": "Creates a new Pause",
19926 "title": "Example usage:",
19927 "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19931 "name": "CreatePauses",
19947 "field": "description",
19953 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19954 "version": "0.0.0",
19955 "filename": "server/api/pause/index.js",
19956 "groupTitle": "Pauses"
19960 "url": "/api/pauses/{id}",
19961 "title": "Deletes a Pause",
19964 "title": "Example usage:",
19965 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19969 "name": "DeletePauses",
19971 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19972 "version": "0.0.0",
19973 "filename": "server/api/pause/index.js",
19974 "groupTitle": "Pauses"
19978 "url": "/api/pauses",
19979 "title": "Gets a list of Pauses",
19982 "title": "Example usage:",
19983 "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19987 "name": "GetPauses",
19989 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19990 "version": "0.0.0",
19991 "filename": "server/api/pause/index.js",
19992 "groupTitle": "Pauses"
19996 "url": "/api/pauses/{id}",
19997 "title": "Gets a single Pause",
20000 "title": "Example usage:",
20001 "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
20005 "name": "ShowPauses",
20007 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20008 "version": "0.0.0",
20009 "filename": "server/api/pause/index.js",
20010 "groupTitle": "Pauses"
20014 "url": "/api/pauses/{id}",
20015 "title": "Update an existing Pause",
20018 "title": "Example usage:",
20019 "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20023 "name": "updatePauses",
20025 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20026 "version": "0.0.0",
20027 "filename": "server/api/pause/index.js",
20028 "groupTitle": "Pauses"
20032 "url": "/api/plugins",
20033 "title": "Gets a list of Plugins",
20036 "title": "Example usage:",
20037 "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
20041 "name": "GetPlugins",
20042 "group": "Plugins",
20043 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20044 "version": "0.0.0",
20045 "filename": "server/api/plugin/index.js",
20046 "groupTitle": "Plugins"
20050 "url": "/api/plugins/{id}",
20051 "title": "Gets a single Plugin",
20054 "title": "Example usage:",
20055 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
20059 "name": "ShowPlugins",
20060 "group": "Plugins",
20061 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20062 "version": "0.0.0",
20063 "filename": "server/api/plugin/index.js",
20064 "groupTitle": "Plugins"
20068 "url": "/api/plugins/{id}",
20069 "title": "Delete a plugin",
20072 "title": "Example usage:",
20073 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
20077 "name": "destroyPlugin",
20078 "group": "Plugins",
20079 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20080 "version": "0.0.0",
20081 "filename": "server/api/plugin/index.js",
20082 "groupTitle": "Plugins"
20086 "url": "/api/plugins/{id}/download",
20087 "title": "Download plugin source code",
20090 "title": "Example usage:",
20091 "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
20095 "name": "download",
20096 "group": "Plugins",
20097 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20098 "version": "0.0.0",
20099 "filename": "server/api/plugin/index.js",
20100 "groupTitle": "Plugins"
20104 "url": "/api/plugins/{id}",
20105 "title": "Update an existing plugin",
20108 "title": "Example usage:",
20109 "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
20113 "name": "updatePlugin",
20114 "group": "Plugins",
20115 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20116 "version": "0.0.0",
20117 "filename": "server/api/plugin/index.js",
20118 "groupTitle": "Plugins"
20122 "url": "/api/plugins",
20123 "title": "Upload new plugin",
20126 "title": "Example usage:",
20127 "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
20131 "name": "uploadPlugin",
20132 "group": "Plugins",
20133 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20134 "version": "0.0.0",
20135 "filename": "server/api/plugin/index.js",
20136 "groupTitle": "Plugins"
20140 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
20141 "title": "Redirect a plugin request to the specified path",
20144 "title": "Example usage:",
20145 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
20149 "name": "webhookPlugin",
20150 "group": "Plugins",
20151 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20152 "version": "0.0.0",
20153 "filename": "server/api/plugin/index.js",
20154 "groupTitle": "Plugins"
20158 "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
20159 "title": "Redirect a plugin request to the specified path",
20162 "title": "Example usage:",
20163 "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
20167 "name": "webhookPlugin",
20168 "group": "Plugins",
20169 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20170 "version": "0.0.0",
20171 "filename": "server/api/plugin/index.js",
20172 "groupTitle": "Plugins"
20176 "url": "/api/pm2/{id}",
20177 "title": "Deletes an existing process",
20180 "title": "Example usage:",
20181 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
20185 "name": "DeletePm2Process",
20187 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20188 "version": "0.0.0",
20189 "filename": "server/api/pm2/index.js",
20190 "groupTitle": "Pm2"
20194 "url": "/api/pm2/{id}",
20195 "title": "Gets a single pm2 process",
20198 "title": "Example usage:",
20199 "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
20203 "name": "GetPm2Process",
20205 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20206 "version": "0.0.0",
20207 "filename": "server/api/pm2/index.js",
20208 "groupTitle": "Pm2"
20213 "title": "Gets pm2 processes",
20216 "title": "Example usage:",
20217 "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
20221 "name": "GetPm2Processes",
20223 "description": "<p>Motion returns the pm2 processes list.</p>",
20224 "version": "0.0.0",
20225 "filename": "server/api/pm2/index.js",
20226 "groupTitle": "Pm2"
20231 "title": "Start a single pm2 process",
20234 "title": "Example usage:",
20235 "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",
20239 "name": "StartPm2Process",
20261 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20262 "version": "0.0.0",
20263 "filename": "server/api/pm2/index.js",
20264 "groupTitle": "Pm2"
20268 "url": "/api/pm2/{id}",
20269 "title": "Update an existing process",
20272 "title": "Example usage:",
20273 "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20277 "name": "UpdatePm2Process",
20279 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20280 "version": "0.0.0",
20281 "filename": "server/api/pm2/index.js",
20282 "groupTitle": "Pm2"
20286 "url": "/api/rpc/campaigns/",
20287 "title": "Gets a list of campaigns",
20290 "title": "Example usage:",
20291 "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
20295 "name": "Campaigns",
20296 "group": "RPC_Realtime",
20297 "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>",
20298 "version": "0.0.0",
20299 "filename": "server/api/rpc/index.js",
20300 "groupTitle": "RPC_Realtime"
20304 "url": "/api/rpc/fax/accounts",
20305 "title": "Gets a list of FaxAccounts",
20308 "title": "Example usage:",
20309 "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
20313 "name": "FaxAccounts",
20314 "group": "RPC_Realtime",
20315 "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>",
20316 "version": "0.0.0",
20317 "filename": "server/api/rpc/index.js",
20318 "groupTitle": "RPC_Realtime"
20322 "url": "/api/rpc/agents/:id/capacity",
20323 "title": "Sets agent capacity",
20326 "title": "Example usage:",
20327 "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
20331 "name": "RTAgentCapacity",
20332 "group": "RPC_Realtime",
20333 "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>",
20334 "version": "0.0.0",
20335 "filename": "server/api/rpc/index.js",
20336 "groupTitle": "RPC_Realtime"
20340 "url": "/api/rpc/agents",
20341 "title": "Gets a list of RTAgents",
20344 "title": "Example usage:",
20345 "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
20349 "name": "RTAgents",
20350 "group": "RPC_Realtime",
20351 "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>",
20352 "version": "0.0.0",
20353 "filename": "server/api/rpc/index.js",
20354 "groupTitle": "RPC_Realtime"
20358 "url": "/api/rpc/chat/queues",
20359 "title": "Gets a list of RTChatQueues",
20362 "title": "Example usage:",
20363 "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
20367 "name": "RTChatQueues",
20368 "group": "RPC_Realtime",
20369 "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>",
20370 "version": "0.0.0",
20371 "filename": "server/api/rpc/index.js",
20372 "groupTitle": "RPC_Realtime"
20376 "url": "/api/rpc/fax/queues",
20377 "title": "Gets a list of RTFaxQueues",
20380 "title": "Example usage:",
20381 "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
20385 "name": "RTFaxQueues",
20386 "group": "RPC_Realtime",
20387 "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>",
20388 "version": "0.0.0",
20389 "filename": "server/api/rpc/index.js",
20390 "groupTitle": "RPC_Realtime"
20394 "url": "/api/rpc/mail/accounts",
20395 "title": "Gets a list of RTMailAccounts",
20398 "title": "Example usage:",
20399 "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
20403 "name": "RTMailAccounts",
20404 "group": "RPC_Realtime",
20405 "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>",
20406 "version": "0.0.0",
20407 "filename": "server/api/rpc/index.js",
20408 "groupTitle": "RPC_Realtime"
20412 "url": "/api/rpc/mail/queues",
20413 "title": "Gets a list of RTMailQueues",
20416 "title": "Example usage:",
20417 "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
20421 "name": "RTMailQueues",
20422 "group": "RPC_Realtime",
20423 "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>",
20424 "version": "0.0.0",
20425 "filename": "server/api/rpc/index.js",
20426 "groupTitle": "RPC_Realtime"
20430 "url": "/api/rpc/openchannel/queues",
20431 "title": "Gets a list of RTOpenchannelQueues",
20434 "title": "Example usage:",
20435 "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
20439 "name": "RTOpenchannelQueues",
20440 "group": "RPC_Realtime",
20441 "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>",
20442 "version": "0.0.0",
20443 "filename": "server/api/rpc/index.js",
20444 "groupTitle": "RPC_Realtime"
20448 "url": "/api/rpc/outbound/channels",
20449 "title": "Gets a list of RTOutboundChannels",
20452 "title": "Example usage:",
20453 "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
20457 "name": "RTOutboundChannels",
20458 "group": "RPC_Realtime",
20459 "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>",
20460 "version": "0.0.0",
20461 "filename": "server/api/rpc/index.js",
20462 "groupTitle": "RPC_Realtime"
20466 "url": "/api/rpc/sms/queues",
20467 "title": "Gets a list of RTSmsQueues",
20470 "title": "Example usage:",
20471 "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
20475 "name": "RTSmsQueues",
20476 "group": "RPC_Realtime",
20477 "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>",
20478 "version": "0.0.0",
20479 "filename": "server/api/rpc/index.js",
20480 "groupTitle": "RPC_Realtime"
20484 "url": "/api/rpc/telephones",
20485 "title": "Gets a list of RTTelephones",
20488 "title": "Example usage:",
20489 "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
20493 "name": "RTTelephones",
20494 "group": "RPC_Realtime",
20495 "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>",
20496 "version": "0.0.0",
20497 "filename": "server/api/rpc/index.js",
20498 "groupTitle": "RPC_Realtime"
20502 "url": "/api/rpc/trunks",
20503 "title": "Gets a list of RTTrunks",
20506 "title": "Example usage:",
20507 "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
20511 "name": "RTTrunks",
20512 "group": "RPC_Realtime",
20513 "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>",
20514 "version": "0.0.0",
20515 "filename": "server/api/rpc/index.js",
20516 "groupTitle": "RPC_Realtime"
20520 "url": "/api/rpc/voice/channels",
20521 "title": "Gets a list of RTVoiceChannelMixMonitor",
20524 "title": "Example usage:",
20525 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
20529 "name": "RTVoiceChannelMixMonitor",
20530 "group": "RPC_Realtime",
20531 "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>",
20532 "version": "0.0.0",
20533 "filename": "server/api/rpc/index.js",
20534 "groupTitle": "RPC_Realtime"
20538 "url": "/api/rpc/voice/channels",
20539 "title": "Gets a list of RTVoiceChannelStopMixMonitor",
20542 "title": "Example usage:",
20543 "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
20547 "name": "RTVoiceChannelStopMixMonitor",
20548 "group": "RPC_Realtime",
20549 "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>",
20550 "version": "0.0.0",
20551 "filename": "server/api/rpc/index.js",
20552 "groupTitle": "RPC_Realtime"
20556 "url": "/api/rpc/voice/channels",
20557 "title": "Gets a list of RTVoiceChannels",
20560 "title": "Example usage:",
20561 "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
20565 "name": "RTVoiceChannels",
20566 "group": "RPC_Realtime",
20567 "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>",
20568 "version": "0.0.0",
20569 "filename": "server/api/rpc/index.js",
20570 "groupTitle": "RPC_Realtime"
20574 "url": "/api/rpc/voice/queues/channels/{uniqueid}",
20575 "title": "Gets a single RTVoiceQueueChannel",
20578 "title": "Example usage:",
20579 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
20583 "name": "RTVoiceQueueChannel",
20584 "group": "RPC_Realtime",
20585 "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20586 "version": "0.0.0",
20587 "filename": "server/api/rpc/index.js",
20588 "groupTitle": "RPC_Realtime"
20592 "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
20593 "title": "Hangup a single RTVoiceQueueChannel",
20596 "title": "Example usage:",
20597 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
20601 "name": "RTVoiceQueueChannelHangup",
20602 "group": "RPC_Realtime",
20603 "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20604 "version": "0.0.0",
20605 "filename": "server/api/rpc/index.js",
20606 "groupTitle": "RPC_Realtime"
20610 "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
20611 "title": "Hangup a single RTVoiceQueueChannel",
20614 "title": "Example usage:",
20615 "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
20619 "name": "RTVoiceQueueChannelRedirect",
20620 "group": "RPC_Realtime",
20621 "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>",
20622 "version": "0.0.0",
20623 "filename": "server/api/rpc/index.js",
20624 "groupTitle": "RPC_Realtime"
20628 "url": "/api/rpc/voice/queues/preview/{id}",
20629 "title": "Gets a single preview contact",
20632 "title": "Example usage:",
20633 "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
20637 "name": "RTVoiceQueuePreview",
20638 "group": "RPC_Realtime",
20639 "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20640 "version": "0.0.0",
20641 "filename": "server/api/rpc/index.js",
20642 "groupTitle": "RPC_Realtime"
20646 "url": "/api/rpc/voice/queues",
20647 "title": "Gets a list of RTVoiceQueues",
20650 "title": "Example usage:",
20651 "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
20655 "name": "RTVoiceQueues",
20656 "group": "RPC_Realtime",
20657 "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>",
20658 "version": "0.0.0",
20659 "filename": "server/api/rpc/index.js",
20660 "groupTitle": "RPC_Realtime"
20664 "url": "/api/rpc/outbound",
20665 "title": "Gets a list of RTOutbound",
20668 "title": "Example usage:",
20669 "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
20673 "name": "RTVoiceQueues",
20674 "group": "RPC_Realtime",
20675 "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>",
20676 "version": "0.0.0",
20677 "filename": "server/api/rpc/index.js",
20678 "groupTitle": "RPC_Realtime"
20682 "url": "/api/rpc/voice/queues/channels",
20683 "title": "Gets a list of RTVoiceQueuesChannels",
20686 "title": "Example usage:",
20687 "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
20691 "name": "RTVoiceQueuesChannels",
20692 "group": "RPC_Realtime",
20693 "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>",
20694 "version": "0.0.0",
20695 "filename": "server/api/rpc/index.js",
20696 "groupTitle": "RPC_Realtime"
20700 "url": "/api/rpc/chat/queues/{id}",
20701 "title": "Gets a single RTChatQueue",
20704 "title": "Example usage:",
20705 "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
20709 "name": "ShowRTChatQueues",
20710 "group": "RPC_Realtime",
20711 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20712 "version": "0.0.0",
20713 "filename": "server/api/rpc/index.js",
20714 "groupTitle": "RPC_Realtime"
20718 "url": "/api/rpc/fax/queues/{id}",
20719 "title": "Gets a single RTFaxQueue",
20722 "title": "Example usage:",
20723 "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
20727 "name": "ShowRTFaxQueues",
20728 "group": "RPC_Realtime",
20729 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20730 "version": "0.0.0",
20731 "filename": "server/api/rpc/index.js",
20732 "groupTitle": "RPC_Realtime"
20736 "url": "/api/rpc/mail/queues/{id}",
20737 "title": "Gets a single RTMailQueue",
20740 "title": "Example usage:",
20741 "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
20745 "name": "ShowRTMailQueues",
20746 "group": "RPC_Realtime",
20747 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20748 "version": "0.0.0",
20749 "filename": "server/api/rpc/index.js",
20750 "groupTitle": "RPC_Realtime"
20754 "url": "/api/rpc/openchannel/queues/{id}",
20755 "title": "Gets a single RTOpenchannelQueue",
20758 "title": "Example usage:",
20759 "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
20763 "name": "ShowRTOpenchannelQueues",
20764 "group": "RPC_Realtime",
20765 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20766 "version": "0.0.0",
20767 "filename": "server/api/rpc/index.js",
20768 "groupTitle": "RPC_Realtime"
20772 "url": "/api/rpc/sms/queues/{id}",
20773 "title": "Gets a single RTSmsQueue",
20776 "title": "Example usage:",
20777 "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
20781 "name": "ShowRTSmsQueues",
20782 "group": "RPC_Realtime",
20783 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20784 "version": "0.0.0",
20785 "filename": "server/api/rpc/index.js",
20786 "groupTitle": "RPC_Realtime"
20790 "url": "/api/rpc/voice/queues/{id}",
20791 "title": "Gets a single RTVoiceQueue",
20794 "title": "Example usage:",
20795 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20799 "name": "ShowRTVoiceQueues",
20800 "group": "RPC_Realtime",
20801 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20802 "version": "0.0.0",
20803 "filename": "server/api/rpc/index.js",
20804 "groupTitle": "RPC_Realtime"
20808 "url": "/api/rpc/voice/{id}/queues",
20809 "title": "Updates a single VoiceQueue",
20812 "title": "Example usage:",
20813 "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20817 "name": "UpdateVoiceQueues",
20818 "group": "RPC_Realtime",
20819 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20820 "version": "0.0.0",
20821 "filename": "server/api/rpc/index.js",
20822 "groupTitle": "RPC_Realtime"
20826 "url": "/api/rpc/agents/:id/notify",
20827 "title": "Notify message to a specific agent",
20830 "title": "Example usage:",
20831 "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",
20835 "name": "agentNotify",
20836 "group": "RPC_Realtime",
20837 "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>",
20838 "version": "0.0.0",
20839 "filename": "server/api/rpc/index.js",
20840 "groupTitle": "RPC_Realtime"
20844 "url": "/api/rpc/chat/queues/:id/notify",
20845 "title": "Notify message to a specific queue",
20848 "title": "Example usage:",
20849 "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",
20853 "name": "chatQueueNotify",
20854 "group": "RPC_Realtime",
20855 "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>",
20856 "version": "0.0.0",
20857 "filename": "server/api/rpc/index.js",
20858 "groupTitle": "RPC_Realtime"
20862 "url": "/api/rpc/chat/queues/waitinginteractions",
20863 "title": "Gets a list of chatQueuesWaitingInteractions",
20866 "title": "Example usage:",
20867 "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20871 "name": "chatQueuesWaitingInteractions",
20872 "group": "RPC_Realtime",
20873 "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>",
20874 "version": "0.0.0",
20875 "filename": "server/api/rpc/index.js",
20876 "groupTitle": "RPC_Realtime"
20880 "url": "/api/rpc/fax/queues/:id/notify",
20881 "title": "Notify message to a specific queue",
20884 "title": "Example usage:",
20885 "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",
20889 "name": "faxQueueNotify",
20890 "group": "RPC_Realtime",
20891 "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>",
20892 "version": "0.0.0",
20893 "filename": "server/api/rpc/index.js",
20894 "groupTitle": "RPC_Realtime"
20898 "url": "/api/rpc/fax/queues/waitinginteractions",
20899 "title": "Gets a list of faxQueuesWaitingInteractions",
20902 "title": "Example usage:",
20903 "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20907 "name": "faxQueuesWaitingInteractions",
20908 "group": "RPC_Realtime",
20909 "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>",
20910 "version": "0.0.0",
20911 "filename": "server/api/rpc/index.js",
20912 "groupTitle": "RPC_Realtime"
20916 "url": "/api/rpc/mail/queues/:id/notify",
20917 "title": "Notify message to a specific queue",
20920 "title": "Example usage:",
20921 "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",
20925 "name": "mailQueueNotify",
20926 "group": "RPC_Realtime",
20927 "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>",
20928 "version": "0.0.0",
20929 "filename": "server/api/rpc/index.js",
20930 "groupTitle": "RPC_Realtime"
20934 "url": "/api/rpc/mail/queues/waitinginteractions",
20935 "title": "Gets a list of mailQueuesWaitingInteractions",
20938 "title": "Example usage:",
20939 "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20943 "name": "mailQueuesWaitingInteractions",
20944 "group": "RPC_Realtime",
20945 "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>",
20946 "version": "0.0.0",
20947 "filename": "server/api/rpc/index.js",
20948 "groupTitle": "RPC_Realtime"
20952 "url": "/api/rpc/openchannel/queues/:id/notify",
20953 "title": "Notify message to a specific queue",
20956 "title": "Example usage:",
20957 "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",
20961 "name": "openchannelQueueNotify",
20962 "group": "RPC_Realtime",
20963 "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>",
20964 "version": "0.0.0",
20965 "filename": "server/api/rpc/index.js",
20966 "groupTitle": "RPC_Realtime"
20970 "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20971 "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20974 "title": "Example usage:",
20975 "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20979 "name": "openchannelQueuesIdWaitingInteractions",
20980 "group": "RPC_Realtime",
20981 "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>",
20982 "version": "0.0.0",
20983 "filename": "server/api/rpc/index.js",
20984 "groupTitle": "RPC_Realtime"
20988 "url": "/api/rpc/openchannel/queues/waitinginteractions",
20989 "title": "Gets a list of openchannelQueuesWaitingInteractions",
20992 "title": "Example usage:",
20993 "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20997 "name": "openchannelQueuesWaitingInteractions",
20998 "group": "RPC_Realtime",
20999 "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>",
21000 "version": "0.0.0",
21001 "filename": "server/api/rpc/index.js",
21002 "groupTitle": "RPC_Realtime"
21006 "url": "/api/rpc/sms/queues/:id/notify",
21007 "title": "Notify message to a specific queue",
21010 "title": "Example usage:",
21011 "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",
21015 "name": "smsQueueNotify",
21016 "group": "RPC_Realtime",
21017 "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>",
21018 "version": "0.0.0",
21019 "filename": "server/api/rpc/index.js",
21020 "groupTitle": "RPC_Realtime"
21024 "url": "/api/rpc/sms/queues/waitinginteractions",
21025 "title": "Gets a list of smsQueuesWaitingInteractions",
21028 "title": "Example usage:",
21029 "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
21033 "name": "smsQueuesWaitingInteractions",
21034 "group": "RPC_Realtime",
21035 "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>",
21036 "version": "0.0.0",
21037 "filename": "server/api/rpc/index.js",
21038 "groupTitle": "RPC_Realtime"
21042 "url": "/api/realtime/agents",
21043 "title": "Gets realtime agents info",
21046 "title": "Example usage:",
21047 "content": "curl https://{domain}/api/realtime/agents -v -u {name}:{password} -X GET",
21051 "name": "getAgents",
21052 "group": "Realtime",
21053 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21054 "version": "0.0.0",
21055 "filename": "server/api/realtime/index.js",
21056 "groupTitle": "Realtime"
21060 "url": "/api/realtime/queues",
21061 "title": "Gets realtime queues info",
21064 "title": "Example usage:",
21065 "content": "curl https://{domain}/api/realtime/queues -v -u {name}:{password} -X GET",
21069 "name": "getQueues",
21070 "group": "Realtime",
21071 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21072 "version": "0.0.0",
21073 "filename": "server/api/realtime/index.js",
21074 "groupTitle": "Realtime"
21078 "url": "/api/integrations/salesforce/accounts",
21079 "title": "Creates a new Salesforce Account",
21082 "title": "Example usage:",
21083 "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",
21087 "name": "CreateSalesforce_Accounts",
21088 "group": "Salesforce_Accounts",
21103 "field": "description",
21110 "field": "username",
21117 "field": "remoteUri",
21124 "field": "password",
21131 "field": "clientId",
21138 "field": "clientSecret",
21145 "field": "securityToken",
21152 "field": "serverUrl",
21159 "\"integrationTab\"",
21169 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21170 "version": "0.0.0",
21171 "filename": "server/api/intSalesforceAccount/index.js",
21172 "groupTitle": "Salesforce_Accounts"
21176 "url": "/api/integrations/salesforce/accounts/{id}",
21177 "title": "Deletes a Salesforce Account",
21180 "title": "Example usage:",
21181 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
21185 "name": "DeleteSalesforce_Accounts",
21186 "group": "Salesforce_Accounts",
21187 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21188 "version": "0.0.0",
21189 "filename": "server/api/intSalesforceAccount/index.js",
21190 "groupTitle": "Salesforce_Accounts"
21194 "url": "/api/integrations/salesforce/accounts",
21195 "title": "Gets a list of Salesforce Accounts",
21198 "title": "Example usage:",
21199 "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
21203 "name": "GetSalesforce_Accounts",
21204 "group": "Salesforce_Accounts",
21205 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21206 "version": "0.0.0",
21207 "filename": "server/api/intSalesforceAccount/index.js",
21208 "groupTitle": "Salesforce_Accounts"
21212 "url": "/api/integrations/salesforce/accounts/{id}",
21213 "title": "Gets a single Salesforce Account",
21216 "title": "Example usage:",
21217 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
21221 "name": "ShowSalesforce_Accounts",
21222 "group": "Salesforce_Accounts",
21223 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21224 "version": "0.0.0",
21225 "filename": "server/api/intSalesforceAccount/index.js",
21226 "groupTitle": "Salesforce_Accounts"
21230 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
21231 "title": "Creates new configuration",
21234 "title": "Example usage:",
21235 "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",
21239 "name": "addConfiguration",
21240 "group": "Salesforce_Accounts",
21241 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21242 "version": "0.0.0",
21243 "filename": "server/api/intSalesforceAccount/index.js",
21244 "groupTitle": "Salesforce_Accounts"
21248 "url": "/api/integrations/salesforce/accounts/{id}/configurations",
21249 "title": "Gets account configurations",
21252 "title": "Example usage:",
21253 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21257 "name": "getConfigurations",
21258 "group": "Salesforce_Accounts",
21259 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21260 "version": "0.0.0",
21261 "filename": "server/api/intSalesforceAccount/index.js",
21262 "groupTitle": "Salesforce_Accounts"
21266 "url": "/api/integrations/salesforce/accounts/{id}/fields",
21267 "title": "Gets account fields",
21270 "title": "Example usage:",
21271 "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
21275 "name": "getFields",
21276 "group": "Salesforce_Accounts",
21277 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21278 "version": "0.0.0",
21279 "filename": "server/api/intSalesforceAccount/index.js",
21280 "groupTitle": "Salesforce_Accounts"
21284 "url": "/api/integrations/salesforce/accounts/{id}",
21285 "title": "Update an existing Salesforce Account",
21288 "title": "Example usage:",
21289 "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",
21293 "name": "updateSalesforce_Accounts",
21294 "group": "Salesforce_Accounts",
21295 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21296 "version": "0.0.0",
21297 "filename": "server/api/intSalesforceAccount/index.js",
21298 "groupTitle": "Salesforce_Accounts"
21302 "url": "/api/integrations/salesforce/configurations",
21303 "title": "Creates a new Salesforce Configuration",
21306 "title": "Example usage:",
21307 "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",
21311 "name": "CreateSalesforce_Configurations",
21312 "group": "Salesforce_Configurations",
21327 "field": "description",
21338 "field": "ticketType",
21345 "\"contact_lead\"",
21348 "\"account_contact_lead\"",
21352 "field": "moduleSearch",
21365 "field": "moduleCreate",
21379 "field": "additionalSearchAccount",
21386 "field": "additionalSearchContact",
21393 "field": "additionalSearchLead",
21399 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21400 "version": "0.0.0",
21401 "filename": "server/api/intSalesforceConfiguration/index.js",
21402 "groupTitle": "Salesforce_Configurations"
21406 "url": "/api/integrations/salesforce/configurations/{id}",
21407 "title": "Deletes a Salesforce Configuration",
21410 "title": "Example usage:",
21411 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
21415 "name": "DeleteSalesforce_Configurations",
21416 "group": "Salesforce_Configurations",
21417 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21418 "version": "0.0.0",
21419 "filename": "server/api/intSalesforceConfiguration/index.js",
21420 "groupTitle": "Salesforce_Configurations"
21424 "url": "/api/integrations/salesforce/configurations",
21425 "title": "Gets a list of Salesforce Configurations",
21428 "title": "Example usage:",
21429 "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
21433 "name": "GetSalesforce_Configurations",
21434 "group": "Salesforce_Configurations",
21435 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21436 "version": "0.0.0",
21437 "filename": "server/api/intSalesforceConfiguration/index.js",
21438 "groupTitle": "Salesforce_Configurations"
21442 "url": "/api/integrations/salesforce/configurations/{id}",
21443 "title": "Gets a single Salesforce Configuration",
21446 "title": "Example usage:",
21447 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
21451 "name": "ShowSalesforce_Configurations",
21452 "group": "Salesforce_Configurations",
21453 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21454 "version": "0.0.0",
21455 "filename": "server/api/intSalesforceConfiguration/index.js",
21456 "groupTitle": "Salesforce_Configurations"
21460 "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
21461 "title": "Gets configurations descriptions",
21464 "title": "Example usage:",
21465 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21469 "name": "getDescriptions",
21470 "group": "Salesforce_Configurations",
21471 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21472 "version": "0.0.0",
21473 "filename": "server/api/intSalesforceConfiguration/index.js",
21474 "groupTitle": "Salesforce_Configurations"
21478 "url": "/api/integrations/salesforce/configurations/{id}/fields",
21479 "title": "Gets configurations fields",
21482 "title": "Example usage:",
21483 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
21487 "name": "getFields",
21488 "group": "Salesforce_Configurations",
21489 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21490 "version": "0.0.0",
21491 "filename": "server/api/intSalesforceConfiguration/index.js",
21492 "groupTitle": "Salesforce_Configurations"
21496 "url": "/api/integrations/salesforce/configurations/{id}/subjects",
21497 "title": "Gets configurations subjects",
21500 "title": "Example usage:",
21501 "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21505 "name": "getSubjects",
21506 "group": "Salesforce_Configurations",
21507 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21508 "version": "0.0.0",
21509 "filename": "server/api/intSalesforceConfiguration/index.js",
21510 "groupTitle": "Salesforce_Configurations"
21514 "url": "/api/integrations/salesforce/configurations/{id}",
21515 "title": "Update an existing Salesforce Configuration",
21518 "title": "Example usage:",
21519 "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",
21523 "name": "updateSalesforce_Configurations",
21524 "group": "Salesforce_Configurations",
21525 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21526 "version": "0.0.0",
21527 "filename": "server/api/intSalesforceConfiguration/index.js",
21528 "groupTitle": "Salesforce_Configurations"
21532 "url": "/api/integrations/salesforce/fields",
21533 "title": "Creates a new Salesforce Field",
21536 "title": "Example usage:",
21537 "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",
21541 "name": "CreateSalesforce_Fields",
21542 "group": "Salesforce_Fields",
21552 "\"customVariable\"",
21564 "field": "content",
21580 "\"customVariable\""
21583 "field": "keyType",
21590 "field": "keyContent",
21597 "field": "idField",
21604 "field": "variableName",
21610 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21611 "version": "0.0.0",
21612 "filename": "server/api/intSalesforceField/index.js",
21613 "groupTitle": "Salesforce_Fields"
21617 "url": "/api/integrations/salesforce/fields/{id}",
21618 "title": "Deletes a Salesforce Field",
21621 "title": "Example usage:",
21622 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
21626 "name": "DeleteSalesforce_Fields",
21627 "group": "Salesforce_Fields",
21628 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21629 "version": "0.0.0",
21630 "filename": "server/api/intSalesforceField/index.js",
21631 "groupTitle": "Salesforce_Fields"
21635 "url": "/api/integrations/salesforce/fields",
21636 "title": "Gets a list of Salesforce Fields",
21639 "title": "Example usage:",
21640 "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
21644 "name": "GetSalesforce_Fields",
21645 "group": "Salesforce_Fields",
21646 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21647 "version": "0.0.0",
21648 "filename": "server/api/intSalesforceField/index.js",
21649 "groupTitle": "Salesforce_Fields"
21653 "url": "/api/integrations/salesforce/fields/{id}",
21654 "title": "Gets a single Salesforce Field",
21657 "title": "Example usage:",
21658 "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
21662 "name": "ShowSalesforce_Fields",
21663 "group": "Salesforce_Fields",
21664 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21665 "version": "0.0.0",
21666 "filename": "server/api/intSalesforceField/index.js",
21667 "groupTitle": "Salesforce_Fields"
21671 "url": "/api/integrations/salesforce/fields/{id}",
21672 "title": "Update an existing Salesforce Field",
21675 "title": "Example usage:",
21676 "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",
21680 "name": "updateSalesforce_Fields",
21681 "group": "Salesforce_Fields",
21682 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21683 "version": "0.0.0",
21684 "filename": "server/api/intSalesforceField/index.js",
21685 "groupTitle": "Salesforce_Fields"
21689 "url": "/api/schedules",
21690 "title": "Creates a new Schedule",
21693 "title": "Example usage:",
21694 "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21698 "name": "CreateSchedules",
21699 "group": "Schedules",
21714 "field": "description",
21735 "field": "startAt",
21749 "field": "subtractNumber",
21765 "field": "subtractUnit",
21795 "field": "sendMail",
21823 "field": "sendIfEmpty",
21829 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21830 "version": "0.0.0",
21831 "filename": "server/api/schedule/index.js",
21832 "groupTitle": "Schedules"
21836 "url": "/api/schedules/{id}",
21837 "title": "Deletes a Schedule",
21840 "title": "Example usage:",
21841 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
21845 "name": "DeleteSchedules",
21846 "group": "Schedules",
21847 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21848 "version": "0.0.0",
21849 "filename": "server/api/schedule/index.js",
21850 "groupTitle": "Schedules"
21854 "url": "/api/schedules",
21855 "title": "Gets a list of Schedules",
21858 "title": "Example usage:",
21859 "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21863 "name": "GetSchedules",
21864 "group": "Schedules",
21865 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21866 "version": "0.0.0",
21867 "filename": "server/api/schedule/index.js",
21868 "groupTitle": "Schedules"
21872 "url": "/api/schedules/{id}",
21873 "title": "Gets a single Schedule",
21876 "title": "Example usage:",
21877 "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21881 "name": "ShowSchedules",
21882 "group": "Schedules",
21883 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21884 "version": "0.0.0",
21885 "filename": "server/api/schedule/index.js",
21886 "groupTitle": "Schedules"
21890 "url": "/api/schedules/{id}/run",
21891 "title": "Run Scheduler",
21894 "title": "Example usage:",
21895 "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21900 "group": "Schedules",
21901 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21902 "version": "0.0.0",
21903 "filename": "server/api/schedule/index.js",
21904 "groupTitle": "Schedules"
21908 "url": "/api/schedules/{id}",
21909 "title": "Update an existing Schedule",
21912 "title": "Example usage:",
21913 "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21917 "name": "updateSchedules",
21918 "group": "Schedules",
21919 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21920 "version": "0.0.0",
21921 "filename": "server/api/schedule/index.js",
21922 "groupTitle": "Schedules"
21926 "url": "/api/screen/recordings",
21927 "title": "Creates a new Recording",
21930 "title": "Example usage:",
21931 "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21935 "name": "CreateRecordings",
21936 "group": "Screen_Recordings",
21951 "field": "interactionid",
21958 "field": "channel",
21979 "field": "duration",
21986 "field": "startedAt",
21993 "field": "closedAt",
22000 "field": "createdAt",
22007 "field": "updatedAt",
22013 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22014 "version": "0.0.0",
22015 "filename": "server/api/screenRecording/index.js",
22016 "groupTitle": "Screen_Recordings"
22020 "url": "/api/screen/recordings/describe",
22021 "title": "Gets table info about Recordings",
22024 "title": "Example usage:",
22025 "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
22029 "name": "DescribeRecordings",
22030 "group": "Screen_Recordings",
22031 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22032 "version": "0.0.0",
22033 "filename": "server/api/screenRecording/index.js",
22034 "groupTitle": "Screen_Recordings"
22038 "url": "/api/screen/recordings",
22039 "title": "Gets a list of Recordings",
22042 "title": "Example usage:",
22043 "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
22047 "name": "GetRecordings",
22048 "group": "Screen_Recordings",
22049 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22050 "version": "0.0.0",
22051 "filename": "server/api/screenRecording/index.js",
22052 "groupTitle": "Screen_Recordings"
22056 "url": "/api/screen/recordings/{id}",
22057 "title": "Gets a single Recording",
22060 "title": "Example usage:",
22061 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
22065 "name": "ShowRecordings",
22066 "group": "Screen_Recordings",
22067 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22068 "version": "0.0.0",
22069 "filename": "server/api/screenRecording/index.js",
22070 "groupTitle": "Screen_Recordings"
22074 "url": "/api/screen/recordings/{id}",
22075 "title": "Delete screen recording",
22078 "title": "Example usage:",
22079 "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
22084 "group": "Screen_Recordings",
22085 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22086 "version": "0.0.0",
22087 "filename": "server/api/screenRecording/index.js",
22088 "groupTitle": "Screen_Recordings"
22092 "url": "/api/screen/recordings/{id}/download",
22093 "title": "Download Recording",
22096 "title": "Example usage:",
22097 "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
22101 "name": "download",
22102 "group": "Screen_Recordings",
22103 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22104 "version": "0.0.0",
22105 "filename": "server/api/screenRecording/index.js",
22106 "groupTitle": "Screen_Recordings"
22110 "url": "/api/screen/recordings/{id}",
22111 "title": "Update an existing Recording",
22114 "title": "Example usage:",
22115 "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",
22119 "name": "updateRecordings",
22120 "group": "Screen_Recordings",
22121 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22122 "version": "0.0.0",
22123 "filename": "server/api/screenRecording/index.js",
22124 "groupTitle": "Screen_Recordings"
22128 "url": "/api/integrations/servicenow/accounts",
22129 "title": "Creates a new Servicenow Account",
22132 "title": "Example usage:",
22133 "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",
22137 "name": "CreateServicenow_Accounts",
22138 "group": "Servicenow_Accounts",
22153 "field": "description",
22160 "field": "username",
22167 "field": "password",
22181 "field": "remoteUri",
22188 "field": "serverUrl",
22194 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22195 "version": "0.0.0",
22196 "filename": "server/api/intServicenowAccount/index.js",
22197 "groupTitle": "Servicenow_Accounts"
22201 "url": "/api/integrations/servicenow/accounts/{id}",
22202 "title": "Deletes a Servicenow Account",
22205 "title": "Example usage:",
22206 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
22210 "name": "DeleteServicenow_Accounts",
22211 "group": "Servicenow_Accounts",
22212 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22213 "version": "0.0.0",
22214 "filename": "server/api/intServicenowAccount/index.js",
22215 "groupTitle": "Servicenow_Accounts"
22219 "url": "/api/integrations/servicenow/accounts",
22220 "title": "Gets a list of Servicenow Accounts",
22223 "title": "Example usage:",
22224 "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
22228 "name": "GetServicenow_Accounts",
22229 "group": "Servicenow_Accounts",
22230 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22231 "version": "0.0.0",
22232 "filename": "server/api/intServicenowAccount/index.js",
22233 "groupTitle": "Servicenow_Accounts"
22237 "url": "/api/integrations/servicenow/accounts/{id}",
22238 "title": "Gets a single Servicenow Account",
22241 "title": "Example usage:",
22242 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
22246 "name": "ShowServicenow_Accounts",
22247 "group": "Servicenow_Accounts",
22248 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22249 "version": "0.0.0",
22250 "filename": "server/api/intServicenowAccount/index.js",
22251 "groupTitle": "Servicenow_Accounts"
22255 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
22256 "title": "Creates new configuration",
22259 "title": "Example usage:",
22260 "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",
22264 "name": "addConfiguration",
22265 "group": "Servicenow_Accounts",
22266 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22267 "version": "0.0.0",
22268 "filename": "server/api/intServicenowAccount/index.js",
22269 "groupTitle": "Servicenow_Accounts"
22273 "url": "/api/integrations/servicenow/accounts/{id}/configurations",
22274 "title": "Gets account configurations",
22277 "title": "Example usage:",
22278 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
22282 "name": "getConfigurations",
22283 "group": "Servicenow_Accounts",
22284 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22285 "version": "0.0.0",
22286 "filename": "server/api/intServicenowAccount/index.js",
22287 "groupTitle": "Servicenow_Accounts"
22291 "url": "/api/integrations/servicenow/accounts/{id}/fields",
22292 "title": "Gets account fields",
22295 "title": "Example usage:",
22296 "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
22300 "name": "getFields",
22301 "group": "Servicenow_Accounts",
22302 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22303 "version": "0.0.0",
22304 "filename": "server/api/intServicenowAccount/index.js",
22305 "groupTitle": "Servicenow_Accounts"
22309 "url": "/api/integrations/servicenow/accounts/{id}",
22310 "title": "Update an existing Servicenow Account",
22313 "title": "Example usage:",
22314 "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",
22318 "name": "updateServicenow_Accounts",
22319 "group": "Servicenow_Accounts",
22320 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22321 "version": "0.0.0",
22322 "filename": "server/api/intServicenowAccount/index.js",
22323 "groupTitle": "Servicenow_Accounts"
22327 "url": "/api/integrations/servicenow/configurations",
22328 "title": "Creates a new Servicenow Configuration",
22331 "title": "Example usage:",
22332 "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",
22336 "name": "CreateServicenow_Configurations",
22337 "group": "Servicenow_Configurations",
22352 "field": "description",
22358 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22359 "version": "0.0.0",
22360 "filename": "server/api/intServicenowConfiguration/index.js",
22361 "groupTitle": "Servicenow_Configurations"
22365 "url": "/api/integrations/servicenow/configurations/{id}",
22366 "title": "Deletes a Servicenow Configuration",
22369 "title": "Example usage:",
22370 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
22374 "name": "DeleteServicenow_Configurations",
22375 "group": "Servicenow_Configurations",
22376 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22377 "version": "0.0.0",
22378 "filename": "server/api/intServicenowConfiguration/index.js",
22379 "groupTitle": "Servicenow_Configurations"
22383 "url": "/api/integrations/servicenow/configurations",
22384 "title": "Gets a list of Servicenow Configurations",
22387 "title": "Example usage:",
22388 "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
22392 "name": "GetServicenow_Configurations",
22393 "group": "Servicenow_Configurations",
22394 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22395 "version": "0.0.0",
22396 "filename": "server/api/intServicenowConfiguration/index.js",
22397 "groupTitle": "Servicenow_Configurations"
22401 "url": "/api/integrations/servicenow/configurations/{id}",
22402 "title": "Gets a single Servicenow Configuration",
22405 "title": "Example usage:",
22406 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
22410 "name": "ShowServicenow_Configurations",
22411 "group": "Servicenow_Configurations",
22412 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22413 "version": "0.0.0",
22414 "filename": "server/api/intServicenowConfiguration/index.js",
22415 "groupTitle": "Servicenow_Configurations"
22419 "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
22420 "title": "Gets configurations descriptions",
22423 "title": "Example usage:",
22424 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
22428 "name": "getDescriptions",
22429 "group": "Servicenow_Configurations",
22430 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22431 "version": "0.0.0",
22432 "filename": "server/api/intServicenowConfiguration/index.js",
22433 "groupTitle": "Servicenow_Configurations"
22437 "url": "/api/integrations/servicenow/configurations/{id}/fields",
22438 "title": "Gets configurations fields",
22441 "title": "Example usage:",
22442 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
22446 "name": "getFields",
22447 "group": "Servicenow_Configurations",
22448 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22449 "version": "0.0.0",
22450 "filename": "server/api/intServicenowConfiguration/index.js",
22451 "groupTitle": "Servicenow_Configurations"
22455 "url": "/api/integrations/servicenow/configurations/{id}/subjects",
22456 "title": "Gets configurations subjects",
22459 "title": "Example usage:",
22460 "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
22464 "name": "getSubjects",
22465 "group": "Servicenow_Configurations",
22466 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22467 "version": "0.0.0",
22468 "filename": "server/api/intServicenowConfiguration/index.js",
22469 "groupTitle": "Servicenow_Configurations"
22473 "url": "/api/integrations/servicenow/configurations/{id}",
22474 "title": "Update an existing Servicenow Configuration",
22477 "title": "Example usage:",
22478 "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",
22482 "name": "updateServicenow_Configurations",
22483 "group": "Servicenow_Configurations",
22484 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22485 "version": "0.0.0",
22486 "filename": "server/api/intServicenowConfiguration/index.js",
22487 "groupTitle": "Servicenow_Configurations"
22491 "url": "/api/integrations/servicenow/fields",
22492 "title": "Creates a new Servicenow Field",
22495 "title": "Example usage:",
22496 "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",
22500 "name": "CreateServicenow_Fields",
22501 "group": "Servicenow_Fields",
22511 "\"customVariable\"",
22523 "field": "content",
22539 "\"customVariable\""
22542 "field": "keyType",
22549 "field": "keyContent",
22556 "field": "idField",
22563 "field": "nameField",
22570 "field": "customField",
22577 "field": "variableName",
22583 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22584 "version": "0.0.0",
22585 "filename": "server/api/intServicenowField/index.js",
22586 "groupTitle": "Servicenow_Fields"
22590 "url": "/api/integrations/servicenow/fields/{id}",
22591 "title": "Deletes a Servicenow Field",
22594 "title": "Example usage:",
22595 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
22599 "name": "DeleteServicenow_Fields",
22600 "group": "Servicenow_Fields",
22601 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22602 "version": "0.0.0",
22603 "filename": "server/api/intServicenowField/index.js",
22604 "groupTitle": "Servicenow_Fields"
22608 "url": "/api/integrations/servicenow/fields",
22609 "title": "Gets a list of Servicenow Fields",
22612 "title": "Example usage:",
22613 "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
22617 "name": "GetServicenow_Fields",
22618 "group": "Servicenow_Fields",
22619 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22620 "version": "0.0.0",
22621 "filename": "server/api/intServicenowField/index.js",
22622 "groupTitle": "Servicenow_Fields"
22626 "url": "/api/integrations/servicenow/fields/{id}",
22627 "title": "Gets a single Servicenow Field",
22630 "title": "Example usage:",
22631 "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
22635 "name": "ShowServicenow_Fields",
22636 "group": "Servicenow_Fields",
22637 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22638 "version": "0.0.0",
22639 "filename": "server/api/intServicenowField/index.js",
22640 "groupTitle": "Servicenow_Fields"
22644 "url": "/api/integrations/servicenow/fields/{id}",
22645 "title": "Update an existing Servicenow Field",
22648 "title": "Example usage:",
22649 "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",
22653 "name": "updateServicenow_Fields",
22654 "group": "Servicenow_Fields",
22655 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22656 "version": "0.0.0",
22657 "filename": "server/api/intServicenowField/index.js",
22658 "groupTitle": "Servicenow_Fields"
22662 "url": "/api/settings",
22663 "title": "Gets a list of Settings",
22666 "title": "Example usage:",
22667 "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
22671 "name": "GetSettings",
22672 "group": "Settings",
22673 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22674 "version": "0.0.0",
22675 "filename": "server/api/setting/index.js",
22676 "groupTitle": "Settings"
22680 "url": "/api/settings/{id}",
22681 "title": "Gets a single Setting",
22684 "title": "Example usage:",
22685 "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
22689 "name": "ShowSettings",
22690 "group": "Settings",
22691 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22692 "version": "0.0.0",
22693 "filename": "server/api/setting/index.js",
22694 "groupTitle": "Settings"
22698 "url": "/api/settings/{id}/favicon",
22699 "title": "Add Favicon",
22702 "title": "Example usage:",
22703 "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22707 "name": "addFavicon",
22708 "group": "Settings",
22709 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22710 "version": "0.0.0",
22711 "filename": "server/api/setting/index.js",
22712 "groupTitle": "Settings"
22716 "url": "/api/settings/{id}/logo",
22717 "title": "Add logo",
22720 "title": "Example usage:",
22721 "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22726 "group": "Settings",
22727 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22728 "version": "0.0.0",
22729 "filename": "server/api/setting/index.js",
22730 "groupTitle": "Settings"
22734 "url": "/api/settings/{id}/logo_login",
22735 "title": "Add logo login",
22738 "title": "Example usage:",
22739 "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22743 "name": "addLogoLogin",
22744 "group": "Settings",
22745 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22746 "version": "0.0.0",
22747 "filename": "server/api/setting/index.js",
22748 "groupTitle": "Settings"
22752 "url": "/api/settings/{id}/preferred",
22753 "title": "Add Preferred",
22756 "title": "Example usage:",
22757 "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22761 "name": "addPreferred",
22762 "group": "Settings",
22763 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22764 "version": "0.0.0",
22765 "filename": "server/api/setting/index.js",
22766 "groupTitle": "Settings"
22770 "url": "/api/settings/now",
22771 "title": "Get Server Current Date",
22774 "title": "Example usage:",
22775 "content": "curl https://{domain}/api/settings/now -v -X GET",
22780 "group": "Settings",
22781 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22782 "version": "0.0.0",
22783 "filename": "server/api/setting/index.js",
22784 "groupTitle": "Settings"
22788 "url": "/api/settings/{id}/favicon",
22789 "title": "Get Favicon",
22792 "title": "Example usage:",
22793 "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
22797 "name": "getFavicon",
22798 "group": "Settings",
22799 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22800 "version": "0.0.0",
22801 "filename": "server/api/setting/index.js",
22802 "groupTitle": "Settings"
22806 "url": "/api/settings/{id}/gdpr",
22807 "title": "Get gdpr settings",
22810 "title": "Example usage:",
22811 "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
22816 "group": "Settings",
22817 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22818 "version": "0.0.0",
22819 "filename": "server/api/setting/index.js",
22820 "groupTitle": "Settings"
22824 "url": "/api/settings/{id}/logo",
22825 "title": "Get logo",
22828 "title": "Example usage:",
22829 "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
22834 "group": "Settings",
22835 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22836 "version": "0.0.0",
22837 "filename": "server/api/setting/index.js",
22838 "groupTitle": "Settings"
22842 "url": "/api/settings/{id}/logo_login",
22843 "title": "Get logo login",
22846 "title": "Example usage:",
22847 "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
22851 "name": "getLogoLogin",
22852 "group": "Settings",
22853 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22854 "version": "0.0.0",
22855 "filename": "server/api/setting/index.js",
22856 "groupTitle": "Settings"
22860 "url": "/api/settings/{id}/preferred",
22861 "title": "Get Preferred",
22864 "title": "Example usage:",
22865 "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22869 "name": "getPreferred",
22870 "group": "Settings",
22871 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22872 "version": "0.0.0",
22873 "filename": "server/api/setting/index.js",
22874 "groupTitle": "Settings"
22878 "url": "/api/settings/{id}",
22879 "title": "Update an existing Setting",
22882 "title": "Example usage:",
22883 "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22887 "name": "updateSettings",
22888 "group": "Settings",
22889 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22890 "version": "0.0.0",
22891 "filename": "server/api/setting/index.js",
22892 "groupTitle": "Settings"
22896 "url": "/api/sms/accounts/{id}/users",
22897 "title": "Add agents to a sms account",
22900 "title": "Example usage:",
22901 "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",
22905 "name": "AddAgents",
22906 "group": "Sms_Accounts",
22907 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22908 "version": "0.0.0",
22909 "filename": "server/api/smsAccount/index.js",
22910 "groupTitle": "Sms_Accounts"
22914 "url": "/api/sms/accounts",
22915 "title": "Creates a new Account",
22918 "title": "Example usage:",
22919 "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22923 "name": "CreateAccounts",
22924 "group": "Sms_Accounts",
22986 "field": "accountSid",
23000 "field": "authToken",
23012 "field": "smsMethod",
23019 "field": "username",
23026 "field": "password",
23040 "field": "applicationId",
23047 "field": "accountId",
23054 "field": "senderString",
23061 "field": "deliveryReport",
23068 "field": "description",
23075 "field": "notificationTemplate",
23082 "field": "notificationSound",
23089 "field": "notificationShake",
23096 "field": "waitForTheAssignedAgent",
23103 "field": "queueTransfer",
23110 "field": "queueTransferTimeout",
23117 "field": "agentTransfer",
23124 "field": "agentTransferTimeout",
23131 "field": "baseUrl",
23138 "field": "mandatoryDispositionPauseId",
23139 "description": "<p>Status to put when mandatory disposition is enabled</p>"
23145 "field": "mandatoryDisposition",
23146 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
23151 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23152 "version": "0.0.0",
23153 "filename": "server/api/smsAccount/index.js",
23154 "groupTitle": "Sms_Accounts"
23158 "url": "/api/sms/accounts/{id}",
23159 "title": "Deletes a Account",
23162 "title": "Example usage:",
23163 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
23167 "name": "DeleteAccounts",
23168 "group": "Sms_Accounts",
23169 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23170 "version": "0.0.0",
23171 "filename": "server/api/smsAccount/index.js",
23172 "groupTitle": "Sms_Accounts"
23176 "url": "/api/sms/accounts/describe",
23177 "title": "Gets table info about Accounts",
23180 "title": "Example usage:",
23181 "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
23185 "name": "DescribeAccounts",
23186 "group": "Sms_Accounts",
23187 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23188 "version": "0.0.0",
23189 "filename": "server/api/smsAccount/index.js",
23190 "groupTitle": "Sms_Accounts"
23194 "url": "/api/sms/accounts",
23195 "title": "Gets a list of Accounts",
23198 "title": "Example usage:",
23199 "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
23203 "name": "GetAccounts",
23204 "group": "Sms_Accounts",
23205 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23206 "version": "0.0.0",
23207 "filename": "server/api/smsAccount/index.js",
23208 "groupTitle": "Sms_Accounts"
23212 "url": "/api/sms/accounts/{id}/users",
23213 "title": "Gets agents from sms account",
23216 "title": "Example usage:",
23217 "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
23221 "name": "GetAgents",
23222 "group": "Sms_Accounts",
23223 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23224 "version": "0.0.0",
23225 "filename": "server/api/smsAccount/index.js",
23226 "groupTitle": "Sms_Accounts"
23230 "url": "/api/sms/accounts/{id}/users",
23231 "title": "Removes agents from a sms account",
23234 "title": "Example usage:",
23235 "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23239 "name": "RemoveAgents",
23240 "group": "Sms_Accounts",
23241 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23242 "version": "0.0.0",
23243 "filename": "server/api/smsAccount/index.js",
23244 "groupTitle": "Sms_Accounts"
23248 "url": "/api/sms/accounts/{id}/canned_answers",
23249 "title": "Removes canned answers from account",
23252 "title": "Example usage:",
23253 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23257 "name": "RemoveAnswers",
23258 "group": "Sms_Accounts",
23259 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23260 "version": "0.0.0",
23261 "filename": "server/api/smsAccount/index.js",
23262 "groupTitle": "Sms_Accounts"
23266 "url": "/api/sms/accounts/{id}/dispositions",
23267 "title": "Removes dispositions from account",
23270 "title": "Example usage:",
23271 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23275 "name": "RemoveDispositions",
23276 "group": "Sms_Accounts",
23277 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23278 "version": "0.0.0",
23279 "filename": "server/api/smsAccount/index.js",
23280 "groupTitle": "Sms_Accounts"
23284 "url": "/api/sms/accounts/{id}",
23285 "title": "Gets a single Account",
23288 "title": "Example usage:",
23289 "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
23293 "name": "ShowAccounts",
23294 "group": "Sms_Accounts",
23295 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23296 "version": "0.0.0",
23297 "filename": "server/api/smsAccount/index.js",
23298 "groupTitle": "Sms_Accounts"
23302 "url": "/api/sms/messages/{id}/accept",
23303 "title": "Accepts message",
23306 "title": "Example usage:",
23307 "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
23311 "name": "acceptMessage",
23312 "group": "Sms_Accounts",
23313 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23314 "version": "0.0.0",
23315 "filename": "server/api/smsMessage/index.js",
23316 "groupTitle": "Sms_Accounts"
23320 "url": "/api/sms/accounts/{id}/canned_answers",
23321 "title": "Creates new canned answer",
23324 "title": "Example usage:",
23325 "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",
23329 "name": "addAnswer",
23330 "group": "Sms_Accounts",
23352 "field": "description",
23365 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23366 "version": "0.0.0",
23367 "filename": "server/api/smsAccount/index.js",
23368 "groupTitle": "Sms_Accounts"
23372 "url": "/api/sms/accounts/{id}/applications",
23373 "title": "Creates new applications",
23376 "title": "Example usage:",
23377 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23381 "name": "addApplications",
23382 "group": "Sms_Accounts",
23390 "field": "priority",
23404 "field": "appdata",
23411 "field": "description",
23418 "field": "interval",
23424 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23425 "version": "0.0.0",
23426 "filename": "server/api/smsAccount/index.js",
23427 "groupTitle": "Sms_Accounts"
23431 "url": "/api/sms/accounts/{id}/dispositions",
23432 "title": "Creates new disposition",
23435 "title": "Example usage:",
23436 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23440 "name": "addDisposition",
23441 "group": "Sms_Accounts",
23468 "field": "description",
23474 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23475 "version": "0.0.0",
23476 "filename": "server/api/smsAccount/index.js",
23477 "groupTitle": "Sms_Accounts"
23481 "url": "/api/sms/accounts/{id}/canned_answers",
23482 "title": "Gets account canned answers",
23485 "title": "Example usage:",
23486 "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
23490 "name": "getAnswers",
23491 "group": "Sms_Accounts",
23492 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23493 "version": "0.0.0",
23494 "filename": "server/api/smsAccount/index.js",
23495 "groupTitle": "Sms_Accounts"
23499 "url": "/api/sms/accounts/{id}/applications",
23500 "title": "Gets account applications",
23503 "title": "Example usage:",
23504 "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
23508 "name": "getApplications",
23509 "group": "Sms_Accounts",
23510 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23511 "version": "0.0.0",
23512 "filename": "server/api/smsAccount/index.js",
23513 "groupTitle": "Sms_Accounts"
23517 "url": "/api/sms/accounts/{id}/dispositions",
23518 "title": "Gets account dispositions",
23521 "title": "Example usage:",
23522 "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
23526 "name": "getDispositions",
23527 "group": "Sms_Accounts",
23528 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23529 "version": "0.0.0",
23530 "filename": "server/api/smsAccount/index.js",
23531 "groupTitle": "Sms_Accounts"
23535 "url": "/api/sms/accounts/{id}/interactions",
23536 "title": "Gets Sms Account interactions",
23539 "title": "Example usage:",
23540 "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
23544 "name": "getInteractions",
23545 "group": "Sms_Accounts",
23546 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23547 "version": "0.0.0",
23548 "filename": "server/api/smsAccount/index.js",
23549 "groupTitle": "Sms_Accounts"
23553 "url": "/api/sms/accounts/{id}/notify",
23554 "title": "Notify new message",
23557 "title": "Example usage:",
23558 "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",
23563 "group": "Sms_Accounts",
23564 "description": "<p>Motion 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>",
23565 "version": "0.0.0",
23566 "filename": "server/api/smsAccount/index.js",
23567 "groupTitle": "Sms_Accounts"
23571 "url": "/api/sms/messages/{id}/reject",
23572 "title": "Rejects message",
23575 "title": "Example usage:",
23576 "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
23580 "name": "rejectMessage",
23581 "group": "Sms_Accounts",
23582 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23583 "version": "0.0.0",
23584 "filename": "server/api/smsMessage/index.js",
23585 "groupTitle": "Sms_Accounts"
23589 "url": "/api/sms/accounts/{id}/send",
23590 "title": "Send new sms message",
23593 "title": "Example usage:",
23594 "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",
23599 "group": "Sms_Accounts",
23600 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23601 "version": "0.0.0",
23602 "filename": "server/api/smsAccount/index.js",
23603 "groupTitle": "Sms_Accounts"
23607 "url": "/api/sms/messages/{id}/status",
23608 "title": "Receive message status",
23611 "title": "Example usage:",
23612 "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
23616 "name": "statusMessage",
23617 "group": "Sms_Accounts",
23618 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23619 "version": "0.0.0",
23620 "filename": "server/api/smsMessage/index.js",
23621 "groupTitle": "Sms_Accounts"
23625 "url": "/api/sms/accounts/{id}/status",
23626 "title": "Receive message status as get request",
23629 "title": "Example usage:",
23630 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
23634 "name": "statusMessage",
23635 "group": "Sms_Accounts",
23636 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23637 "version": "0.0.0",
23638 "filename": "server/api/smsAccount/index.js",
23639 "groupTitle": "Sms_Accounts"
23643 "url": "/api/sms/accounts/{id}/status",
23644 "title": "Receive message status",
23647 "title": "Example usage:",
23648 "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
23652 "name": "statusMessage",
23653 "group": "Sms_Accounts",
23654 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23655 "version": "0.0.0",
23656 "filename": "server/api/smsAccount/index.js",
23657 "groupTitle": "Sms_Accounts"
23661 "url": "/api/sms/accounts/{id}",
23662 "title": "Update an existing Account",
23665 "title": "Example usage:",
23666 "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",
23670 "name": "updateAccounts",
23671 "group": "Sms_Accounts",
23672 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23673 "version": "0.0.0",
23674 "filename": "server/api/smsAccount/index.js",
23675 "groupTitle": "Sms_Accounts"
23679 "url": "/api/sms/applications",
23680 "title": "Creates a new Application",
23683 "title": "Example usage:",
23684 "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23688 "name": "CreateApplications",
23689 "group": "Sms_Applications",
23697 "field": "priority",
23711 "field": "appdata",
23718 "field": "description",
23725 "field": "interval",
23731 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23732 "version": "0.0.0",
23733 "filename": "server/api/smsApplication/index.js",
23734 "groupTitle": "Sms_Applications"
23738 "url": "/api/sms/applications/{id}",
23739 "title": "Deletes a Application",
23742 "title": "Example usage:",
23743 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
23747 "name": "DeleteApplications",
23748 "group": "Sms_Applications",
23749 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23750 "version": "0.0.0",
23751 "filename": "server/api/smsApplication/index.js",
23752 "groupTitle": "Sms_Applications"
23756 "url": "/api/sms/applications",
23757 "title": "Gets a list of Applications",
23760 "title": "Example usage:",
23761 "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
23765 "name": "GetApplications",
23766 "group": "Sms_Applications",
23767 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23768 "version": "0.0.0",
23769 "filename": "server/api/smsApplication/index.js",
23770 "groupTitle": "Sms_Applications"
23774 "url": "/api/sms/applications/{id}",
23775 "title": "Gets a single Application",
23778 "title": "Example usage:",
23779 "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
23783 "name": "ShowApplications",
23784 "group": "Sms_Applications",
23785 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23786 "version": "0.0.0",
23787 "filename": "server/api/smsApplication/index.js",
23788 "groupTitle": "Sms_Applications"
23792 "url": "/api/sms/applications/{id}",
23793 "title": "Update an existing Application",
23796 "title": "Example usage:",
23797 "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",
23801 "name": "updateApplications",
23802 "group": "Sms_Applications",
23803 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23804 "version": "0.0.0",
23805 "filename": "server/api/smsApplication/index.js",
23806 "groupTitle": "Sms_Applications"
23810 "url": "/api/sms/interactions/{id}/tags",
23811 "title": "Add tags to the interaction",
23814 "title": "Example usage:",
23815 "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",
23820 "group": "Sms_Interactions",
23821 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23822 "version": "0.0.0",
23823 "filename": "server/api/smsInteraction/index.js",
23824 "groupTitle": "Sms_Interactions"
23828 "url": "/api/sms/interactions",
23829 "title": "Creates a new Interaction",
23832 "title": "Example usage:",
23833 "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23837 "name": "CreateInteractions",
23838 "group": "Sms_Interactions",
23853 "field": "closedAt",
23860 "field": "disposition",
23867 "field": "secondDisposition",
23874 "field": "thirdDisposition",
23895 "field": "read1stAt",
23906 "field": "firstMsgDirection",
23913 "field": "lastMsgAt",
23924 "field": "lastMsgDirection",
23931 "field": "autoreplyExecuted",
23937 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23938 "version": "0.0.0",
23939 "filename": "server/api/smsInteraction/index.js",
23940 "groupTitle": "Sms_Interactions"
23944 "url": "/api/sms/interactions/{id}",
23945 "title": "Deletes a Interaction",
23948 "title": "Example usage:",
23949 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23953 "name": "DeleteInteractions",
23954 "group": "Sms_Interactions",
23955 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23956 "version": "0.0.0",
23957 "filename": "server/api/smsInteraction/index.js",
23958 "groupTitle": "Sms_Interactions"
23962 "url": "/api/sms/interactions/describe",
23963 "title": "Gets table info about Interactions",
23966 "title": "Example usage:",
23967 "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23971 "name": "DescribeInteractions",
23972 "group": "Sms_Interactions",
23973 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23974 "version": "0.0.0",
23975 "filename": "server/api/smsInteraction/index.js",
23976 "groupTitle": "Sms_Interactions"
23980 "url": "/api/sms/interactions",
23981 "title": "Gets a list of Interactions",
23984 "title": "Example usage:",
23985 "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23989 "name": "GetInteractions",
23990 "group": "Sms_Interactions",
23991 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23992 "version": "0.0.0",
23993 "filename": "server/api/smsInteraction/index.js",
23994 "groupTitle": "Sms_Interactions"
23998 "url": "/api/sms/interactions/{id}/tags",
23999 "title": "Removes tags from interaction",
24002 "title": "Example usage:",
24003 "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24007 "name": "RemoveTags",
24008 "group": "Sms_Interactions",
24009 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24010 "version": "0.0.0",
24011 "filename": "server/api/smsInteraction/index.js",
24012 "groupTitle": "Sms_Interactions"
24016 "url": "/api/sms/interactions/{id}",
24017 "title": "Gets a single Interaction",
24020 "title": "Example usage:",
24021 "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
24025 "name": "ShowInteractions",
24026 "group": "Sms_Interactions",
24027 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24028 "version": "0.0.0",
24029 "filename": "server/api/smsInteraction/index.js",
24030 "groupTitle": "Sms_Interactions"
24034 "url": "/api/sms/interactions/{id}/messages",
24035 "title": "Creates new messages",
24038 "title": "Example usage:",
24039 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
24043 "name": "addMessage",
24044 "group": "Sms_Interactions",
24070 "field": "direction",
24077 "field": "messageId",
24105 "field": "providerName",
24112 "field": "providerResponse",
24118 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24119 "version": "0.0.0",
24120 "filename": "server/api/smsInteraction/index.js",
24121 "groupTitle": "Sms_Interactions"
24125 "url": "/api/sms/interactions/{id}/download",
24126 "title": "Gets interaction",
24129 "title": "Example usage:",
24130 "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
24134 "name": "download",
24135 "group": "Sms_Interactions",
24136 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24137 "version": "0.0.0",
24138 "filename": "server/api/smsInteraction/index.js",
24139 "groupTitle": "Sms_Interactions"
24143 "url": "/api/sms/interactions/{id}/messages",
24144 "title": "Gets interaction messages",
24147 "title": "Example usage:",
24148 "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
24152 "name": "getMessages",
24153 "group": "Sms_Interactions",
24154 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24155 "version": "0.0.0",
24156 "filename": "server/api/smsInteraction/index.js",
24157 "groupTitle": "Sms_Interactions"
24161 "url": "/api/sms/interactions/{id}",
24162 "title": "Update an existing Interaction",
24165 "title": "Example usage:",
24166 "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",
24170 "name": "updateInteractions",
24171 "group": "Sms_Interactions",
24172 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24173 "version": "0.0.0",
24174 "filename": "server/api/smsInteraction/index.js",
24175 "groupTitle": "Sms_Interactions"
24179 "url": "/api/sms/messages",
24180 "title": "Creates a new Message",
24183 "title": "Example usage:",
24184 "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24188 "name": "CreateMessages",
24189 "group": "Sms_Messages",
24215 "field": "direction",
24222 "field": "messageId",
24250 "field": "providerName",
24257 "field": "providerResponse",
24263 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24264 "version": "0.0.0",
24265 "filename": "server/api/smsMessage/index.js",
24266 "groupTitle": "Sms_Messages"
24270 "url": "/api/sms/messages/{id}",
24271 "title": "Deletes a Message",
24274 "title": "Example usage:",
24275 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
24279 "name": "DeleteMessages",
24280 "group": "Sms_Messages",
24281 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24282 "version": "0.0.0",
24283 "filename": "server/api/smsMessage/index.js",
24284 "groupTitle": "Sms_Messages"
24288 "url": "/api/sms/messages/describe",
24289 "title": "Gets table info about Messages",
24292 "title": "Example usage:",
24293 "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
24297 "name": "DescribeMessages",
24298 "group": "Sms_Messages",
24299 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24300 "version": "0.0.0",
24301 "filename": "server/api/smsMessage/index.js",
24302 "groupTitle": "Sms_Messages"
24306 "url": "/api/sms/messages",
24307 "title": "Gets a list of Messages",
24310 "title": "Example usage:",
24311 "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
24315 "name": "GetMessages",
24316 "group": "Sms_Messages",
24317 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24318 "version": "0.0.0",
24319 "filename": "server/api/smsMessage/index.js",
24320 "groupTitle": "Sms_Messages"
24324 "url": "/api/sms/messages/{id}",
24325 "title": "Gets a single Message",
24328 "title": "Example usage:",
24329 "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
24333 "name": "ShowMessages",
24334 "group": "Sms_Messages",
24335 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24336 "version": "0.0.0",
24337 "filename": "server/api/smsMessage/index.js",
24338 "groupTitle": "Sms_Messages"
24342 "url": "/api/sms/messages/{id}",
24343 "title": "Update an existing Message",
24346 "title": "Example usage:",
24347 "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",
24351 "name": "updateMessages",
24352 "group": "Sms_Messages",
24353 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24354 "version": "0.0.0",
24355 "filename": "server/api/smsMessage/index.js",
24356 "groupTitle": "Sms_Messages"
24360 "url": "/api/sms/reports/queue",
24361 "title": "Creates a new Sms Queue Report",
24364 "title": "Example usage:",
24365 "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",
24369 "name": "CreateSms_Queue_Reports",
24370 "group": "Sms_Queue_Reports",
24378 "field": "uniqueid",
24399 "field": "leaveAt",
24406 "field": "acceptAt",
24426 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24427 "version": "0.0.0",
24428 "filename": "server/api/smsQueueReport/index.js",
24429 "groupTitle": "Sms_Queue_Reports"
24433 "url": "/api/sms/reports/queue/{id}",
24434 "title": "Deletes a Sms Queue Report",
24437 "title": "Example usage:",
24438 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
24442 "name": "DeleteSms_Queue_Reports",
24443 "group": "Sms_Queue_Reports",
24444 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24445 "version": "0.0.0",
24446 "filename": "server/api/smsQueueReport/index.js",
24447 "groupTitle": "Sms_Queue_Reports"
24451 "url": "/api/sms/reports/queue/describe",
24452 "title": "Gets table info about Sms Queue Reports",
24455 "title": "Example usage:",
24456 "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
24460 "name": "DescribeSms_Queue_Reports",
24461 "group": "Sms_Queue_Reports",
24462 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24463 "version": "0.0.0",
24464 "filename": "server/api/smsQueueReport/index.js",
24465 "groupTitle": "Sms_Queue_Reports"
24469 "url": "/api/sms/reports/queue",
24470 "title": "Gets a list of Sms Queue Reports",
24473 "title": "Example usage:",
24474 "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
24478 "name": "GetSms_Queue_Reports",
24479 "group": "Sms_Queue_Reports",
24480 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24481 "version": "0.0.0",
24482 "filename": "server/api/smsQueueReport/index.js",
24483 "groupTitle": "Sms_Queue_Reports"
24487 "url": "/api/sms/reports/queue/{id}",
24488 "title": "Gets a single Sms Queue Report",
24491 "title": "Example usage:",
24492 "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
24496 "name": "ShowSms_Queue_Reports",
24497 "group": "Sms_Queue_Reports",
24498 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24499 "version": "0.0.0",
24500 "filename": "server/api/smsQueueReport/index.js",
24501 "groupTitle": "Sms_Queue_Reports"
24505 "url": "/api/sms/reports/queue/{id}",
24506 "title": "Update an existing Sms Queue Report",
24509 "title": "Example usage:",
24510 "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",
24514 "name": "updateSms_Queue_Reports",
24515 "group": "Sms_Queue_Reports",
24516 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24517 "version": "0.0.0",
24518 "filename": "server/api/smsQueueReport/index.js",
24519 "groupTitle": "Sms_Queue_Reports"
24523 "url": "/api/sms/queues/{id}/users",
24524 "title": "Add agents to a queue",
24527 "title": "Example usage:",
24528 "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",
24532 "name": "AddAgents",
24533 "group": "Sms_Queues",
24534 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24535 "version": "0.0.0",
24536 "filename": "server/api/smsQueue/index.js",
24537 "groupTitle": "Sms_Queues"
24541 "url": "/api/sms/queues/{id}/teams",
24542 "title": "Add teams to a queue",
24545 "title": "Example usage:",
24546 "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",
24550 "name": "AddTeams",
24551 "group": "Sms_Queues",
24552 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24553 "version": "0.0.0",
24554 "filename": "server/api/smsQueue/index.js",
24555 "groupTitle": "Sms_Queues"
24559 "url": "/api/sms/queues",
24560 "title": "Creates a new Queue",
24563 "title": "Example usage:",
24564 "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24568 "name": "CreateQueues",
24569 "group": "Sms_Queues",
24584 "field": "description",
24591 "field": "timeout",
24603 "field": "strategy",
24609 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24610 "version": "0.0.0",
24611 "filename": "server/api/smsQueue/index.js",
24612 "groupTitle": "Sms_Queues"
24616 "url": "/api/sms/queues/{id}",
24617 "title": "Deletes a Queue",
24620 "title": "Example usage:",
24621 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
24625 "name": "DeleteQueues",
24626 "group": "Sms_Queues",
24627 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24628 "version": "0.0.0",
24629 "filename": "server/api/smsQueue/index.js",
24630 "groupTitle": "Sms_Queues"
24634 "url": "/api/sms/queues/describe",
24635 "title": "Gets table info about Queues",
24638 "title": "Example usage:",
24639 "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
24643 "name": "DescribeQueues",
24644 "group": "Sms_Queues",
24645 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24646 "version": "0.0.0",
24647 "filename": "server/api/smsQueue/index.js",
24648 "groupTitle": "Sms_Queues"
24652 "url": "/api/sms/queues/{id}/users",
24653 "title": "Gets queue agents",
24656 "title": "Example usage:",
24657 "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
24661 "name": "GetAgents",
24662 "group": "Sms_Queues",
24663 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24664 "version": "0.0.0",
24665 "filename": "server/api/smsQueue/index.js",
24666 "groupTitle": "Sms_Queues"
24670 "url": "/api/sms/queues/{id}/members",
24671 "title": "GetMembers",
24674 "title": "Example usage:",
24675 "content": "curl https://{domain}/api/sms/queues/{id}/members -v -u {name}:{password}",
24679 "name": "GetMembers",
24680 "group": "Sms_Queues",
24681 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24682 "version": "0.0.0",
24683 "filename": "server/api/smsQueue/index.js",
24684 "groupTitle": "Sms_Queues"
24688 "url": "/api/sms/queues",
24689 "title": "Gets a list of Queues",
24692 "title": "Example usage:",
24693 "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
24697 "name": "GetQueues",
24698 "group": "Sms_Queues",
24699 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24700 "version": "0.0.0",
24701 "filename": "server/api/smsQueue/index.js",
24702 "groupTitle": "Sms_Queues"
24706 "url": "/api/sms/queues/{id}/teams",
24707 "title": "Gets queues list",
24710 "title": "Example usage:",
24711 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
24715 "name": "GetTeams",
24716 "group": "Sms_Queues",
24717 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24718 "version": "0.0.0",
24719 "filename": "server/api/smsQueue/index.js",
24720 "groupTitle": "Sms_Queues"
24724 "url": "/api/sms/queues/{id}/users",
24725 "title": "Removes agents from a queue",
24728 "title": "Example usage:",
24729 "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24733 "name": "RemoveAgents",
24734 "group": "Sms_Queues",
24735 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24736 "version": "0.0.0",
24737 "filename": "server/api/smsQueue/index.js",
24738 "groupTitle": "Sms_Queues"
24742 "url": "/api/sms/queues/{id}",
24743 "title": "Gets a single Queue",
24746 "title": "Example usage:",
24747 "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
24751 "name": "ShowQueues",
24752 "group": "Sms_Queues",
24753 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24754 "version": "0.0.0",
24755 "filename": "server/api/smsQueue/index.js",
24756 "groupTitle": "Sms_Queues"
24760 "url": "/api/sms/queues/{id}",
24761 "title": "Update an existing Queue",
24764 "title": "Example usage:",
24765 "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",
24769 "name": "updateQueues",
24770 "group": "Sms_Queues",
24771 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24772 "version": "0.0.0",
24773 "filename": "server/api/smsQueue/index.js",
24774 "groupTitle": "Sms_Queues"
24778 "url": "/api/sms/reports/transfer",
24779 "title": "Creates a new Sms Transfer Report",
24782 "title": "Example usage:",
24783 "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",
24787 "name": "CreateSms_Transfer_Reports",
24788 "group": "Sms_Transfer_Reports",
24796 "field": "uniqueid",
24815 "field": "transferredAt",
24821 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24822 "version": "0.0.0",
24823 "filename": "server/api/smsTransferReport/index.js",
24824 "groupTitle": "Sms_Transfer_Reports"
24828 "url": "/api/sms/reports/transfer/{id}",
24829 "title": "Deletes a Sms Transfer Report",
24832 "title": "Example usage:",
24833 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
24837 "name": "DeleteSms_Transfer_Reports",
24838 "group": "Sms_Transfer_Reports",
24839 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24840 "version": "0.0.0",
24841 "filename": "server/api/smsTransferReport/index.js",
24842 "groupTitle": "Sms_Transfer_Reports"
24846 "url": "/api/sms/reports/transfer/describe",
24847 "title": "Gets table info about Sms Transfer Reports",
24850 "title": "Example usage:",
24851 "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
24855 "name": "DescribeSms_Transfer_Reports",
24856 "group": "Sms_Transfer_Reports",
24857 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24858 "version": "0.0.0",
24859 "filename": "server/api/smsTransferReport/index.js",
24860 "groupTitle": "Sms_Transfer_Reports"
24864 "url": "/api/sms/reports/transfer",
24865 "title": "Gets a list of Sms Transfer Reports",
24868 "title": "Example usage:",
24869 "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24873 "name": "GetSms_Transfer_Reports",
24874 "group": "Sms_Transfer_Reports",
24875 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24876 "version": "0.0.0",
24877 "filename": "server/api/smsTransferReport/index.js",
24878 "groupTitle": "Sms_Transfer_Reports"
24882 "url": "/api/sms/reports/transfer/{id}",
24883 "title": "Gets a single Sms Transfer Report",
24886 "title": "Example usage:",
24887 "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24891 "name": "ShowSms_Transfer_Reports",
24892 "group": "Sms_Transfer_Reports",
24893 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24894 "version": "0.0.0",
24895 "filename": "server/api/smsTransferReport/index.js",
24896 "groupTitle": "Sms_Transfer_Reports"
24900 "url": "/api/sms/reports/transfer/{id}",
24901 "title": "Update an existing Sms Transfer Report",
24904 "title": "Example usage:",
24905 "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",
24909 "name": "updateSms_Transfer_Reports",
24910 "group": "Sms_Transfer_Reports",
24911 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24912 "version": "0.0.0",
24913 "filename": "server/api/smsTransferReport/index.js",
24914 "groupTitle": "Sms_Transfer_Reports"
24918 "url": "/api/sounds",
24919 "title": "Gets a list of Sounds",
24922 "title": "Example usage:",
24923 "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24927 "name": "GetSounds",
24929 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24930 "version": "0.0.0",
24931 "filename": "server/api/sound/index.js",
24932 "groupTitle": "Sounds"
24936 "url": "/api/sounds/{id}",
24937 "title": "Gets a single Sound",
24940 "title": "Example usage:",
24941 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24945 "name": "ShowSounds",
24947 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24948 "version": "0.0.0",
24949 "filename": "server/api/sound/index.js",
24950 "groupTitle": "Sounds"
24954 "url": "/api/sounds",
24955 "title": "Create a new sound",
24958 "title": "Example usage:",
24959 "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24963 "name": "addSound",
24965 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24966 "version": "0.0.0",
24967 "filename": "server/api/sound/index.js",
24968 "groupTitle": "Sounds"
24972 "url": "/api/sounds/{id}",
24973 "title": "Deletes a sound",
24976 "title": "Example usage:",
24977 "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24981 "name": "destroySound",
24983 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24984 "version": "0.0.0",
24985 "filename": "server/api/sound/index.js",
24986 "groupTitle": "Sounds"
24990 "url": "/api/sounds/{id}/download",
24991 "title": "Download Sound",
24994 "title": "Example usage:",
24995 "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24999 "name": "download",
25001 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25002 "version": "0.0.0",
25003 "filename": "server/api/sound/index.js",
25004 "groupTitle": "Sounds"
25008 "url": "/api/sounds",
25009 "title": "Update an existing new sound",
25012 "title": "Example usage:",
25013 "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
25017 "name": "updateSound",
25019 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25020 "version": "0.0.0",
25021 "filename": "server/api/sound/index.js",
25022 "groupTitle": "Sounds"
25026 "url": "/api/square/details/reports",
25027 "title": "Creates a new Square Detail Report",
25030 "title": "Example usage:",
25031 "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",
25035 "name": "CreateSquare_Detail_Reports",
25036 "group": "Square_Details_Reports",
25044 "field": "uniqueid",
25058 "field": "application",
25072 "field": "project_name",
25079 "field": "callerid",
25085 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25086 "version": "0.0.0",
25087 "filename": "server/api/squareReportDetail/index.js",
25088 "groupTitle": "Square_Details_Reports"
25092 "url": "/api/square/details/reports/{id}",
25093 "title": "Deletes a Square Detail Report",
25096 "title": "Example usage:",
25097 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
25101 "name": "DeleteSquare_Detail_Reports",
25102 "group": "Square_Details_Reports",
25103 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25104 "version": "0.0.0",
25105 "filename": "server/api/squareReportDetail/index.js",
25106 "groupTitle": "Square_Details_Reports"
25110 "url": "/api/square/details/reports/describe",
25111 "title": "Gets table info about Square Detail Reports",
25114 "title": "Example usage:",
25115 "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
25119 "name": "DescribeSquare_Detail_Reports",
25120 "group": "Square_Details_Reports",
25121 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25122 "version": "0.0.0",
25123 "filename": "server/api/squareReportDetail/index.js",
25124 "groupTitle": "Square_Details_Reports"
25128 "url": "/api/square/details/reports",
25129 "title": "Gets a list of Square Detail Reports",
25132 "title": "Example usage:",
25133 "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
25137 "name": "GetSquare_Detail_Reports",
25138 "group": "Square_Details_Reports",
25139 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25140 "version": "0.0.0",
25141 "filename": "server/api/squareReportDetail/index.js",
25142 "groupTitle": "Square_Details_Reports"
25146 "url": "/api/square/details/reports/{id}",
25147 "title": "Gets a single Square Detail Report",
25150 "title": "Example usage:",
25151 "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
25155 "name": "ShowSquare_Detail_Reports",
25156 "group": "Square_Details_Reports",
25157 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25158 "version": "0.0.0",
25159 "filename": "server/api/squareReportDetail/index.js",
25160 "groupTitle": "Square_Details_Reports"
25164 "url": "/api/square/details/reports/{id}",
25165 "title": "Update an existing Square Detail Report",
25168 "title": "Example usage:",
25169 "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",
25173 "name": "updateSquare_Detail_Reports",
25174 "group": "Square_Details_Reports",
25175 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25176 "version": "0.0.0",
25177 "filename": "server/api/squareReportDetail/index.js",
25178 "groupTitle": "Square_Details_Reports"
25182 "url": "/api/square/messages",
25183 "title": "Creates a new Message",
25186 "title": "Example usage:",
25187 "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25191 "name": "CreateMessages",
25192 "group": "Square_Messages",
25200 "field": "uniqueid",
25218 "field": "direction",
25225 "field": "providerName",
25232 "field": "providerResponse",
25238 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25239 "version": "0.0.0",
25240 "filename": "server/api/squareMessage/index.js",
25241 "groupTitle": "Square_Messages"
25245 "url": "/api/square/messages/{id}",
25246 "title": "Deletes a Message",
25249 "title": "Example usage:",
25250 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
25254 "name": "DeleteMessages",
25255 "group": "Square_Messages",
25256 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25257 "version": "0.0.0",
25258 "filename": "server/api/squareMessage/index.js",
25259 "groupTitle": "Square_Messages"
25263 "url": "/api/square/messages",
25264 "title": "Gets a list of Messages",
25267 "title": "Example usage:",
25268 "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
25272 "name": "GetMessages",
25273 "group": "Square_Messages",
25274 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25275 "version": "0.0.0",
25276 "filename": "server/api/squareMessage/index.js",
25277 "groupTitle": "Square_Messages"
25281 "url": "/api/square/messages/{id}",
25282 "title": "Gets a single Message",
25285 "title": "Example usage:",
25286 "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
25290 "name": "ShowMessages",
25291 "group": "Square_Messages",
25292 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25293 "version": "0.0.0",
25294 "filename": "server/api/squareMessage/index.js",
25295 "groupTitle": "Square_Messages"
25299 "url": "/api/square/messages/{id}",
25300 "title": "Update an existing Message",
25303 "title": "Example usage:",
25304 "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",
25308 "name": "updateMessages",
25309 "group": "Square_Messages",
25310 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25311 "version": "0.0.0",
25312 "filename": "server/api/squareMessage/index.js",
25313 "groupTitle": "Square_Messages"
25317 "url": "/api/square/odbc",
25318 "title": "Creates a new ODBC",
25321 "title": "Example usage:",
25322 "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25326 "name": "CreateODBCs",
25327 "group": "Square_ODBC",
25349 "field": "description",
25355 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25356 "version": "0.0.0",
25357 "filename": "server/api/squareOdbc/index.js",
25358 "groupTitle": "Square_ODBC"
25362 "url": "/api/square/odbc/{id}",
25363 "title": "Deletes a ODBC",
25366 "title": "Example usage:",
25367 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
25371 "name": "DeleteODBCs",
25372 "group": "Square_ODBC",
25373 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25374 "version": "0.0.0",
25375 "filename": "server/api/squareOdbc/index.js",
25376 "groupTitle": "Square_ODBC"
25380 "url": "/api/square/odbc",
25381 "title": "Gets a list of ODBCs",
25384 "title": "Example usage:",
25385 "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
25389 "name": "GetODBCs",
25390 "group": "Square_ODBC",
25391 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25392 "version": "0.0.0",
25393 "filename": "server/api/squareOdbc/index.js",
25394 "groupTitle": "Square_ODBC"
25398 "url": "/api/square/odbc/{id}",
25399 "title": "Gets a single ODBC",
25402 "title": "Example usage:",
25403 "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
25407 "name": "ShowODBCs",
25408 "group": "Square_ODBC",
25409 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25410 "version": "0.0.0",
25411 "filename": "server/api/squareOdbc/index.js",
25412 "groupTitle": "Square_ODBC"
25416 "url": "/api/square/odbc/{id}/test",
25417 "title": "Test Odbc",
25420 "title": "Example usage:",
25421 "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
25426 "group": "Square_ODBC",
25427 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25428 "version": "0.0.0",
25429 "filename": "server/api/squareOdbc/index.js",
25430 "groupTitle": "Square_ODBC"
25434 "url": "/api/square/odbc/{id}",
25435 "title": "Update an existing ODBC",
25438 "title": "Example usage:",
25439 "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",
25443 "name": "updateODBCs",
25444 "group": "Square_ODBC",
25445 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25446 "version": "0.0.0",
25447 "filename": "server/api/squareOdbc/index.js",
25448 "groupTitle": "Square_ODBC"
25452 "url": "/api/square/projects",
25453 "title": "Creates a new Project",
25456 "title": "Example usage:",
25457 "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25461 "name": "CreateProjects",
25462 "group": "Square_Projects",
25477 "field": "description",
25491 "field": "preproduction",
25498 "field": "production",
25505 "field": "savedAt",
25512 "field": "publishedAt",
25518 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25519 "version": "0.0.0",
25520 "filename": "server/api/squareProject/index.js",
25521 "groupTitle": "Square_Projects"
25525 "url": "/api/square/projects/{id}",
25526 "title": "Deletes a Project",
25529 "title": "Example usage:",
25530 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
25534 "name": "DeleteProjects",
25535 "group": "Square_Projects",
25536 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25537 "version": "0.0.0",
25538 "filename": "server/api/squareProject/index.js",
25539 "groupTitle": "Square_Projects"
25543 "url": "/api/square/projects",
25544 "title": "Gets a list of Projects",
25547 "title": "Example usage:",
25548 "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
25552 "name": "GetProjects",
25553 "group": "Square_Projects",
25554 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25555 "version": "0.0.0",
25556 "filename": "server/api/squareProject/index.js",
25557 "groupTitle": "Square_Projects"
25561 "url": "/api/square/projects/{id}",
25562 "title": "Gets a single Project",
25565 "title": "Example usage:",
25566 "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
25570 "name": "ShowProjects",
25571 "group": "Square_Projects",
25572 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25573 "version": "0.0.0",
25574 "filename": "server/api/squareProject/index.js",
25575 "groupTitle": "Square_Projects"
25579 "url": "/api/square/projects/{id}",
25580 "title": "Update an existing Project",
25583 "title": "Example usage:",
25584 "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",
25588 "name": "updateProjects",
25589 "group": "Square_Projects",
25590 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25591 "version": "0.0.0",
25592 "filename": "server/api/squareProject/index.js",
25593 "groupTitle": "Square_Projects"
25597 "url": "/api/square/recordings",
25598 "title": "Creates a new Recording",
25601 "title": "Example usage:",
25602 "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25606 "name": "CreateRecordings",
25607 "group": "Square_Recordings",
25615 "field": "uniqueid",
25622 "field": "callerid",
25629 "field": "calleridname",
25636 "field": "context",
25643 "field": "extension",
25650 "field": "priority",
25657 "field": "accountcode",
25671 "field": "projectName",
25678 "field": "saveName",
25685 "field": "filename",
25692 "field": "savePath",
25705 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25706 "version": "0.0.0",
25707 "filename": "server/api/squareRecording/index.js",
25708 "groupTitle": "Square_Recordings"
25712 "url": "/api/square/recordings",
25713 "title": "Gets a list of Recordings",
25716 "title": "Example usage:",
25717 "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
25721 "name": "GetRecordings",
25722 "group": "Square_Recordings",
25723 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25724 "version": "0.0.0",
25725 "filename": "server/api/squareRecording/index.js",
25726 "groupTitle": "Square_Recordings"
25730 "url": "/api/square/recordings/{id}",
25731 "title": "Gets a single Recording",
25734 "title": "Example usage:",
25735 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
25739 "name": "ShowRecordings",
25740 "group": "Square_Recordings",
25741 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25742 "version": "0.0.0",
25743 "filename": "server/api/squareRecording/index.js",
25744 "groupTitle": "Square_Recordings"
25748 "url": "/api/square/recordings/{id}",
25749 "title": "Delete recording",
25752 "title": "Example usage:",
25753 "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",
25758 "group": "Square_Recordings",
25759 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25760 "version": "0.0.0",
25761 "filename": "server/api/squareRecording/index.js",
25762 "groupTitle": "Square_Recordings"
25766 "url": "/api/square/recordings/{id}/download",
25767 "title": "Download Recording",
25770 "title": "Example usage:",
25771 "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
25775 "name": "download",
25776 "group": "Square_Recordings",
25777 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25778 "version": "0.0.0",
25779 "filename": "server/api/squareRecording/index.js",
25780 "groupTitle": "Square_Recordings"
25784 "url": "/api/square/recordings/{id}",
25785 "title": "Update an existing Recording",
25788 "title": "Example usage:",
25789 "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",
25793 "name": "updateRecordings",
25794 "group": "Square_Recordings",
25795 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25796 "version": "0.0.0",
25797 "filename": "server/api/squareRecording/index.js",
25798 "groupTitle": "Square_Recordings"
25802 "url": "/api/square/reports",
25803 "title": "Creates a new Square Report",
25806 "title": "Example usage:",
25807 "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25811 "name": "CreateSquare_Reports",
25812 "group": "Square_Reports",
25820 "field": "network",
25827 "field": "network_script",
25834 "field": "request",
25841 "field": "channel",
25848 "field": "language",
25862 "field": "uniqueid",
25869 "field": "version",
25876 "field": "callerid",
25883 "field": "calleridname",
25890 "field": "callingpres",
25897 "field": "callingani2",
25904 "field": "callington",
25911 "field": "callingtns",
25932 "field": "context",
25939 "field": "extension",
25946 "field": "priority",
25953 "field": "enhanced",
25960 "field": "accountcode",
25967 "field": "threadid",
25974 "field": "project_name",
25988 "field": "leaveAt",
26001 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26002 "version": "0.0.0",
26003 "filename": "server/api/squareReport/index.js",
26004 "groupTitle": "Square_Reports"
26008 "url": "/api/square/reports/{id}",
26009 "title": "Deletes a Square Report",
26012 "title": "Example usage:",
26013 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
26017 "name": "DeleteSquare_Reports",
26018 "group": "Square_Reports",
26019 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26020 "version": "0.0.0",
26021 "filename": "server/api/squareReport/index.js",
26022 "groupTitle": "Square_Reports"
26026 "url": "/api/square/reports/describe",
26027 "title": "Gets table info about Square Reports",
26030 "title": "Example usage:",
26031 "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
26035 "name": "DescribeSquare_Reports",
26036 "group": "Square_Reports",
26037 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26038 "version": "0.0.0",
26039 "filename": "server/api/squareReport/index.js",
26040 "groupTitle": "Square_Reports"
26044 "url": "/api/square/reports",
26045 "title": "Gets a list of Square Reports",
26048 "title": "Example usage:",
26049 "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
26053 "name": "GetSquare_Reports",
26054 "group": "Square_Reports",
26055 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26056 "version": "0.0.0",
26057 "filename": "server/api/squareReport/index.js",
26058 "groupTitle": "Square_Reports"
26062 "url": "/api/square/reports/{id}",
26063 "title": "Gets a single Square Report",
26066 "title": "Example usage:",
26067 "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
26071 "name": "ShowSquare_Reports",
26072 "group": "Square_Reports",
26073 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26074 "version": "0.0.0",
26075 "filename": "server/api/squareReport/index.js",
26076 "groupTitle": "Square_Reports"
26080 "url": "/api/square/reports/{id}",
26081 "title": "Update an existing Square Report",
26084 "title": "Example usage:",
26085 "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",
26089 "name": "updateSquare_Reports",
26090 "group": "Square_Reports",
26091 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26092 "version": "0.0.0",
26093 "filename": "server/api/squareReport/index.js",
26094 "groupTitle": "Square_Reports"
26098 "url": "/api/integrations/sugarcrm/configurations",
26099 "title": "Creates a new SugarCRM Configuration",
26102 "title": "Example usage:",
26103 "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",
26107 "name": "CreateSugarCRM_Configurations",
26108 "group": "SugarCRM_Configurations",
26123 "field": "description",
26129 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26130 "version": "0.0.0",
26131 "filename": "server/api/intSugarcrmConfiguration/index.js",
26132 "groupTitle": "SugarCRM_Configurations"
26136 "url": "/api/integrations/sugarcrm/configurations/{id}",
26137 "title": "Deletes a SugarCRM Configuration",
26140 "title": "Example usage:",
26141 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
26145 "name": "DeleteSugarCRM_Configurations",
26146 "group": "SugarCRM_Configurations",
26147 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26148 "version": "0.0.0",
26149 "filename": "server/api/intSugarcrmConfiguration/index.js",
26150 "groupTitle": "SugarCRM_Configurations"
26154 "url": "/api/integrations/sugarcrm/configurations",
26155 "title": "Gets a list of SugarCRM Configurations",
26158 "title": "Example usage:",
26159 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
26163 "name": "GetSugarCRM_Configurations",
26164 "group": "SugarCRM_Configurations",
26165 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26166 "version": "0.0.0",
26167 "filename": "server/api/intSugarcrmConfiguration/index.js",
26168 "groupTitle": "SugarCRM_Configurations"
26172 "url": "/api/integrations/sugarcrm/configurations/{id}",
26173 "title": "Gets a single SugarCRM Configuration",
26176 "title": "Example usage:",
26177 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
26181 "name": "ShowSugarCRM_Configurations",
26182 "group": "SugarCRM_Configurations",
26183 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26184 "version": "0.0.0",
26185 "filename": "server/api/intSugarcrmConfiguration/index.js",
26186 "groupTitle": "SugarCRM_Configurations"
26190 "url": "/api/integrations/sugarcrm/configurations/{id}",
26191 "title": "Update an existing SugarCRM Configuration",
26194 "title": "Example usage:",
26195 "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",
26199 "name": "updateSugarCRM_Configurations",
26200 "group": "SugarCRM_Configurations",
26201 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26202 "version": "0.0.0",
26203 "filename": "server/api/intSugarcrmConfiguration/index.js",
26204 "groupTitle": "SugarCRM_Configurations"
26208 "url": "/api/integrations/sugarcrm/accounts",
26209 "title": "Creates a new Sugarcrm Account",
26212 "title": "Example usage:",
26213 "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",
26217 "name": "CreateSugarcrm_Accounts",
26218 "group": "Sugarcrm_Accounts",
26233 "field": "description",
26240 "field": "username",
26247 "field": "password",
26254 "field": "remoteUri",
26261 "field": "serverUrl",
26267 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26268 "version": "0.0.0",
26269 "filename": "server/api/intSugarcrmAccount/index.js",
26270 "groupTitle": "Sugarcrm_Accounts"
26274 "url": "/api/integrations/sugarcrm/accounts/{id}",
26275 "title": "Deletes a Sugarcrm Account",
26278 "title": "Example usage:",
26279 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
26283 "name": "DeleteSugarcrm_Accounts",
26284 "group": "Sugarcrm_Accounts",
26285 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26286 "version": "0.0.0",
26287 "filename": "server/api/intSugarcrmAccount/index.js",
26288 "groupTitle": "Sugarcrm_Accounts"
26292 "url": "/api/integrations/sugarcrm/accounts",
26293 "title": "Gets a list of Sugarcrm Accounts",
26296 "title": "Example usage:",
26297 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
26301 "name": "GetSugarcrm_Accounts",
26302 "group": "Sugarcrm_Accounts",
26303 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26304 "version": "0.0.0",
26305 "filename": "server/api/intSugarcrmAccount/index.js",
26306 "groupTitle": "Sugarcrm_Accounts"
26310 "url": "/api/integrations/sugarcrm/accounts/{id}",
26311 "title": "Gets a single Sugarcrm Account",
26314 "title": "Example usage:",
26315 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
26319 "name": "ShowSugarcrm_Accounts",
26320 "group": "Sugarcrm_Accounts",
26321 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26322 "version": "0.0.0",
26323 "filename": "server/api/intSugarcrmAccount/index.js",
26324 "groupTitle": "Sugarcrm_Accounts"
26328 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
26329 "title": "Creates new configuration",
26332 "title": "Example usage:",
26333 "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",
26337 "name": "addConfiguration",
26338 "group": "Sugarcrm_Accounts",
26339 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26340 "version": "0.0.0",
26341 "filename": "server/api/intSugarcrmAccount/index.js",
26342 "groupTitle": "Sugarcrm_Accounts"
26346 "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
26347 "title": "Gets account configurations",
26350 "title": "Example usage:",
26351 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
26355 "name": "getConfigurations",
26356 "group": "Sugarcrm_Accounts",
26357 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26358 "version": "0.0.0",
26359 "filename": "server/api/intSugarcrmAccount/index.js",
26360 "groupTitle": "Sugarcrm_Accounts"
26364 "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
26365 "title": "Gets account fields",
26368 "title": "Example usage:",
26369 "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
26373 "name": "getFields",
26374 "group": "Sugarcrm_Accounts",
26375 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26376 "version": "0.0.0",
26377 "filename": "server/api/intSugarcrmAccount/index.js",
26378 "groupTitle": "Sugarcrm_Accounts"
26382 "url": "/api/integrations/sugarcrm/accounts/{id}",
26383 "title": "Update an existing Sugarcrm Account",
26386 "title": "Example usage:",
26387 "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",
26391 "name": "updateSugarcrm_Accounts",
26392 "group": "Sugarcrm_Accounts",
26393 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26394 "version": "0.0.0",
26395 "filename": "server/api/intSugarcrmAccount/index.js",
26396 "groupTitle": "Sugarcrm_Accounts"
26400 "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
26401 "title": "Gets configurations descriptions",
26404 "title": "Example usage:",
26405 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
26409 "name": "getDescriptions",
26410 "group": "Sugarcrm_Configurations",
26411 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26412 "version": "0.0.0",
26413 "filename": "server/api/intSugarcrmConfiguration/index.js",
26414 "groupTitle": "Sugarcrm_Configurations"
26418 "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
26419 "title": "Gets configurations fields",
26422 "title": "Example usage:",
26423 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
26427 "name": "getFields",
26428 "group": "Sugarcrm_Configurations",
26429 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26430 "version": "0.0.0",
26431 "filename": "server/api/intSugarcrmConfiguration/index.js",
26432 "groupTitle": "Sugarcrm_Configurations"
26436 "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
26437 "title": "Gets configurations subjects",
26440 "title": "Example usage:",
26441 "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
26445 "name": "getSubjects",
26446 "group": "Sugarcrm_Configurations",
26447 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26448 "version": "0.0.0",
26449 "filename": "server/api/intSugarcrmConfiguration/index.js",
26450 "groupTitle": "Sugarcrm_Configurations"
26454 "url": "/api/integrations/sugarcrm/fields",
26455 "title": "Creates a new Sugarcrm Field",
26458 "title": "Example usage:",
26459 "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",
26463 "name": "CreateSugarcrm_Fields",
26464 "group": "Sugarcrm_Fields",
26474 "\"customVariable\"",
26486 "field": "content",
26502 "\"customVariable\""
26505 "field": "keyType",
26512 "field": "keyContent",
26519 "field": "idField",
26526 "field": "nameField",
26533 "field": "customField",
26540 "field": "variableName",
26546 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26547 "version": "0.0.0",
26548 "filename": "server/api/intSugarcrmField/index.js",
26549 "groupTitle": "Sugarcrm_Fields"
26553 "url": "/api/integrations/sugarcrm/fields/{id}",
26554 "title": "Deletes a Sugarcrm Field",
26557 "title": "Example usage:",
26558 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
26562 "name": "DeleteSugarcrm_Fields",
26563 "group": "Sugarcrm_Fields",
26564 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26565 "version": "0.0.0",
26566 "filename": "server/api/intSugarcrmField/index.js",
26567 "groupTitle": "Sugarcrm_Fields"
26571 "url": "/api/integrations/sugarcrm/fields",
26572 "title": "Gets a list of Sugarcrm Fields",
26575 "title": "Example usage:",
26576 "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
26580 "name": "GetSugarcrm_Fields",
26581 "group": "Sugarcrm_Fields",
26582 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26583 "version": "0.0.0",
26584 "filename": "server/api/intSugarcrmField/index.js",
26585 "groupTitle": "Sugarcrm_Fields"
26589 "url": "/api/integrations/sugarcrm/fields/{id}",
26590 "title": "Gets a single Sugarcrm Field",
26593 "title": "Example usage:",
26594 "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
26598 "name": "ShowSugarcrm_Fields",
26599 "group": "Sugarcrm_Fields",
26600 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26601 "version": "0.0.0",
26602 "filename": "server/api/intSugarcrmField/index.js",
26603 "groupTitle": "Sugarcrm_Fields"
26607 "url": "/api/integrations/sugarcrm/fields/{id}",
26608 "title": "Update an existing Sugarcrm Field",
26611 "title": "Example usage:",
26612 "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",
26616 "name": "updateSugarcrm_Fields",
26617 "group": "Sugarcrm_Fields",
26618 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26619 "version": "0.0.0",
26620 "filename": "server/api/intSugarcrmField/index.js",
26621 "groupTitle": "Sugarcrm_Fields"
26625 "url": "/api/system",
26626 "title": "Gets system information",
26629 "title": "Example usage:",
26630 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26634 "name": "GetSystemInformation",
26635 "group": "System_Information",
26636 "description": "<p>Motion returns the system information.</p>",
26637 "version": "0.0.0",
26638 "filename": "server/api/system/index.js",
26639 "groupTitle": "System_Information"
26643 "url": "/api/system/process",
26644 "title": "Gets system information",
26647 "title": "Example usage:",
26648 "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26652 "name": "GetSystemInformation",
26653 "group": "System_Information",
26654 "description": "<p>Motion returns the system information.</p>",
26655 "version": "0.0.0",
26656 "filename": "server/api/system/index.js",
26657 "groupTitle": "System_Information"
26661 "url": "/api/tags",
26662 "title": "Creates a new Tag",
26665 "title": "Example usage:",
26666 "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26670 "name": "CreateTags",
26693 "field": "description",
26699 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26700 "version": "0.0.0",
26701 "filename": "server/api/tag/index.js",
26702 "groupTitle": "Tags"
26706 "url": "/api/tags/{id}",
26707 "title": "Deletes a Tag",
26710 "title": "Example usage:",
26711 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
26715 "name": "DeleteTags",
26717 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26718 "version": "0.0.0",
26719 "filename": "server/api/tag/index.js",
26720 "groupTitle": "Tags"
26724 "url": "/api/tags",
26725 "title": "Gets a list of Tags",
26728 "title": "Example usage:",
26729 "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
26735 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26736 "version": "0.0.0",
26737 "filename": "server/api/tag/index.js",
26738 "groupTitle": "Tags"
26742 "url": "/api/tags/{id}",
26743 "title": "Gets a single Tag",
26746 "title": "Example usage:",
26747 "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
26751 "name": "ShowTags",
26753 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26754 "version": "0.0.0",
26755 "filename": "server/api/tag/index.js",
26756 "groupTitle": "Tags"
26760 "url": "/api/tags/{id}",
26761 "title": "Update an existing Tag",
26764 "title": "Example usage:",
26765 "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26769 "name": "updateTags",
26771 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26772 "version": "0.0.0",
26773 "filename": "server/api/tag/index.js",
26774 "groupTitle": "Tags"
26778 "url": "/api/teams/{id}/queues",
26779 "title": "Add queues to a team",
26782 "title": "Example usage:",
26783 "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26787 "name": "AddQueues",
26789 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26790 "version": "0.0.0",
26791 "filename": "server/api/team/index.js",
26792 "groupTitle": "Teams"
26796 "url": "/api/teams",
26797 "title": "Creates a new Team",
26800 "title": "Example usage:",
26801 "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26805 "name": "CreateTeams",
26821 "field": "description",
26827 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26828 "version": "0.0.0",
26829 "filename": "server/api/team/index.js",
26830 "groupTitle": "Teams"
26834 "url": "/api/teams/{id}",
26835 "title": "Deletes a Team",
26838 "title": "Example usage:",
26839 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26843 "name": "DeleteTeams",
26845 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26846 "version": "0.0.0",
26847 "filename": "server/api/team/index.js",
26848 "groupTitle": "Teams"
26852 "url": "/api/teams/{id}/users",
26853 "title": "Gets agents from team",
26856 "title": "Example usage:",
26857 "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26861 "name": "GetAgents",
26863 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26864 "version": "0.0.0",
26865 "filename": "server/api/team/index.js",
26866 "groupTitle": "Teams"
26870 "url": "/api/teams/{id}/queues?channel={channel}",
26871 "title": "Gets Queues list",
26874 "title": "Example usage:",
26875 "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26879 "name": "GetQueues",
26881 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26882 "version": "0.0.0",
26883 "filename": "server/api/team/index.js",
26884 "groupTitle": "Teams"
26888 "url": "/api/teams",
26889 "title": "Gets a list of Teams",
26892 "title": "Example usage:",
26893 "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26897 "name": "GetTeams",
26899 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26900 "version": "0.0.0",
26901 "filename": "server/api/team/index.js",
26902 "groupTitle": "Teams"
26906 "url": "/api/teams/{id}/users",
26907 "title": "Removes agents from a team",
26910 "title": "Example usage:",
26911 "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26915 "name": "RemoveAgents",
26917 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26918 "version": "0.0.0",
26919 "filename": "server/api/team/index.js",
26920 "groupTitle": "Teams"
26924 "url": "/api/teams/{id}/queues",
26925 "title": "Remove queues to a team",
26928 "title": "Example usage:",
26929 "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26933 "name": "RemoveQueues",
26935 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26936 "version": "0.0.0",
26937 "filename": "server/api/team/index.js",
26938 "groupTitle": "Teams"
26942 "url": "/api/whatsapp/queues/{id}/teams",
26943 "title": "Remove teams from a queue",
26946 "title": "Example usage:",
26947 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26951 "name": "RemoveTeams",
26953 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26954 "version": "0.0.0",
26955 "filename": "server/api/whatsappQueue/index.js",
26956 "groupTitle": "Teams"
26960 "url": "/api/voice/Prefixes/{id}/teams",
26961 "title": "Remove teams from a voice prefix",
26964 "title": "Example usage:",
26965 "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X DELETE",
26969 "name": "RemoveTeams",
26971 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26972 "version": "0.0.0",
26973 "filename": "server/api/voicePrefix/index.js",
26974 "groupTitle": "Teams"
26978 "url": "/api/fax/queues/{id}/teams",
26979 "title": "Remove teams from a queue",
26982 "title": "Example usage:",
26983 "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26987 "name": "RemoveTeams",
26989 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26990 "version": "0.0.0",
26991 "filename": "server/api/faxQueue/index.js",
26992 "groupTitle": "Teams"
26996 "url": "/api/mail/queues/{id}/teams",
26997 "title": "Remove teams from a queue",
27000 "title": "Example usage:",
27001 "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27005 "name": "RemoveTeams",
27007 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27008 "version": "0.0.0",
27009 "filename": "server/api/mailQueue/index.js",
27010 "groupTitle": "Teams"
27014 "url": "/api/voice/queues/{id}/teams",
27015 "title": "Remove teams from a queue",
27018 "title": "Example usage:",
27019 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27023 "name": "RemoveTeams",
27025 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27026 "version": "0.0.0",
27027 "filename": "server/api/voiceQueue/index.js",
27028 "groupTitle": "Teams"
27032 "url": "/api/openchannel/queues/{id}/teams",
27033 "title": "Remove teams from a queue",
27036 "title": "Example usage:",
27037 "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27041 "name": "RemoveTeams",
27043 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27044 "version": "0.0.0",
27045 "filename": "server/api/openchannelQueue/index.js",
27046 "groupTitle": "Teams"
27050 "url": "/api/sms/queues/{id}/teams",
27051 "title": "Remove teams from a queue",
27054 "title": "Example usage:",
27055 "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27059 "name": "RemoveTeams",
27061 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27062 "version": "0.0.0",
27063 "filename": "server/api/smsQueue/index.js",
27064 "groupTitle": "Teams"
27068 "url": "/api/chat/queues/{id}/teams",
27069 "title": "Remove teams from a queue",
27072 "title": "Example usage:",
27073 "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
27077 "name": "RemoveTeams",
27079 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27080 "version": "0.0.0",
27081 "filename": "server/api/chatQueue/index.js",
27082 "groupTitle": "Teams"
27086 "url": "/api/teams/{id}",
27087 "title": "Gets a single Team",
27090 "title": "Example usage:",
27091 "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
27095 "name": "ShowTeams",
27097 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27098 "version": "0.0.0",
27099 "filename": "server/api/team/index.js",
27100 "groupTitle": "Teams"
27104 "url": "/api/teams/{id}/users",
27105 "title": "Adds agents to a team",
27108 "title": "Example usage:",
27109 "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27113 "name": "addAgents",
27115 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27116 "version": "0.0.0",
27117 "filename": "server/api/team/index.js",
27118 "groupTitle": "Teams"
27122 "url": "/api/teams/{id}",
27123 "title": "Update an existing Team",
27126 "title": "Example usage:",
27127 "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27131 "name": "updateTeams",
27133 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27134 "version": "0.0.0",
27135 "filename": "server/api/team/index.js",
27136 "groupTitle": "Teams"
27140 "url": "/api/templates",
27141 "title": "Creates a new Template",
27144 "title": "Example usage:",
27145 "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27149 "name": "CreateTemplates",
27150 "group": "Templates",
27165 "field": "description",
27178 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27179 "version": "0.0.0",
27180 "filename": "server/api/template/index.js",
27181 "groupTitle": "Templates"
27185 "url": "/api/templates/{id}",
27186 "title": "Deletes a Template",
27189 "title": "Example usage:",
27190 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
27194 "name": "DeleteTemplates",
27195 "group": "Templates",
27196 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27197 "version": "0.0.0",
27198 "filename": "server/api/template/index.js",
27199 "groupTitle": "Templates"
27203 "url": "/api/templates",
27204 "title": "Gets a list of Templates",
27207 "title": "Example usage:",
27208 "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
27212 "name": "GetTemplates",
27213 "group": "Templates",
27214 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27215 "version": "0.0.0",
27216 "filename": "server/api/template/index.js",
27217 "groupTitle": "Templates"
27221 "url": "/api/templates/{id}",
27222 "title": "Gets a single Template",
27225 "title": "Example usage:",
27226 "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
27230 "name": "ShowTemplates",
27231 "group": "Templates",
27232 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27233 "version": "0.0.0",
27234 "filename": "server/api/template/index.js",
27235 "groupTitle": "Templates"
27239 "url": "/api/templates/{id}",
27240 "title": "Update an existing Template",
27243 "title": "Example usage:",
27244 "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27248 "name": "updateTemplates",
27249 "group": "Templates",
27250 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27251 "version": "0.0.0",
27252 "filename": "server/api/template/index.js",
27253 "groupTitle": "Templates"
27257 "url": "/api/triggers",
27258 "title": "Creates a new Trigger",
27261 "title": "Example usage:",
27262 "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27266 "name": "CreateTriggers",
27267 "group": "Triggers",
27282 "field": "channel",
27289 "field": "description",
27302 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27303 "version": "0.0.0",
27304 "filename": "server/api/trigger/index.js",
27305 "groupTitle": "Triggers"
27309 "url": "/api/triggers/{id}",
27310 "title": "Deletes a Trigger",
27313 "title": "Example usage:",
27314 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
27318 "name": "DeleteTriggers",
27319 "group": "Triggers",
27320 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27321 "version": "0.0.0",
27322 "filename": "server/api/trigger/index.js",
27323 "groupTitle": "Triggers"
27327 "url": "/api/triggers",
27328 "title": "Gets a list of Triggers",
27331 "title": "Example usage:",
27332 "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
27336 "name": "GetTriggers",
27337 "group": "Triggers",
27338 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27339 "version": "0.0.0",
27340 "filename": "server/api/trigger/index.js",
27341 "groupTitle": "Triggers"
27345 "url": "/api/triggers/{id}",
27346 "title": "Gets a single Trigger",
27349 "title": "Example usage:",
27350 "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
27354 "name": "ShowTriggers",
27355 "group": "Triggers",
27356 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27357 "version": "0.0.0",
27358 "filename": "server/api/trigger/index.js",
27359 "groupTitle": "Triggers"
27363 "url": "/api/triggers/{id}/actions",
27364 "title": "Creates new actions",
27367 "title": "Example usage:",
27368 "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27372 "name": "addAction",
27373 "group": "Triggers",
27389 "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
27396 "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
27403 "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
27410 "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
27443 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27444 "version": "0.0.0",
27445 "filename": "server/api/trigger/index.js",
27446 "groupTitle": "Triggers"
27450 "url": "/api/triggers/{id}/all_conditions",
27451 "title": "Creates a new \"AND\"condition",
27454 "title": "Example usage:",
27455 "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",
27459 "name": "addAllCondition",
27460 "group": "Triggers",
27482 "field": "operator",
27495 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27496 "version": "0.0.0",
27497 "filename": "server/api/trigger/index.js",
27498 "groupTitle": "Triggers"
27502 "url": "/api/triggers/{id}/any_conditions",
27503 "title": "Creates a new \"OR\"condition",
27506 "title": "Example usage:",
27507 "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",
27511 "name": "addAnyCondition",
27512 "group": "Triggers",
27534 "field": "operator",
27547 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27548 "version": "0.0.0",
27549 "filename": "server/api/trigger/index.js",
27550 "groupTitle": "Triggers"
27554 "url": "/api/triggers/{id}/actions",
27555 "title": "Gets Trigger Actions",
27558 "title": "Example usage:",
27559 "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
27563 "name": "getActions",
27564 "group": "Triggers",
27565 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27566 "version": "0.0.0",
27567 "filename": "server/api/trigger/index.js",
27568 "groupTitle": "Triggers"
27572 "url": "/api/triggers/{id}/all_conditions",
27573 "title": "Gets \"AND\" Trigger Conditions",
27576 "title": "Example usage:",
27577 "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
27581 "name": "getAllConditions",
27582 "group": "Triggers",
27583 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27584 "version": "0.0.0",
27585 "filename": "server/api/trigger/index.js",
27586 "groupTitle": "Triggers"
27590 "url": "/api/triggers/{id}/any_conditions",
27591 "title": "Gets \"OR\" Trigger Conditions",
27594 "title": "Example usage:",
27595 "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
27599 "name": "getAnyConditions",
27600 "group": "Triggers",
27601 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27602 "version": "0.0.0",
27603 "filename": "server/api/trigger/index.js",
27604 "groupTitle": "Triggers"
27608 "url": "/api/triggers/{id}",
27609 "title": "Update an existing Trigger",
27612 "title": "Example usage:",
27613 "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27617 "name": "updateTriggers",
27618 "group": "Triggers",
27619 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27620 "version": "0.0.0",
27621 "filename": "server/api/trigger/index.js",
27622 "groupTitle": "Triggers"
27626 "url": "/api/trunks/clone",
27627 "title": "Clone an existing Trunk",
27630 "title": "Example usage:",
27631 "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27635 "name": "CloneTrunks",
27637 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27638 "version": "0.0.0",
27639 "filename": "server/api/trunk/index.js",
27640 "groupTitle": "Trunks"
27644 "url": "/api/trunks",
27645 "title": "Create a new trunk",
27648 "title": "Example usage:",
27649 "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
27681 "field": "context",
27688 "\"ALLOWED_NOT_SCREENED\"",
27689 "\"ALLOWED_PASSED_SCREEN\"",
27690 "\"ALLOWED_FAILED_SCREEN\"",
27692 "\"PROHIB_NOT_SCREENED\"",
27693 "\"PROHIB_PASSED_SCREEN\"",
27694 "\"PROHIB_FAILED_SCREEN\"",
27698 "field": "callingpres",
27726 "field": "md5secret",
27733 "field": "remotesecret",
27740 "field": "transport",
27741 "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"
27754 "field": "dtmfmode",
27768 "field": "directmedia",
27779 "field": "directrtpsetup",
27786 "field": "directmediapermit",
27793 "field": "directmediadeny",
27801 "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"
27807 "field": "callgroup",
27814 "field": "namedcallgroup",
27821 "field": "pickupgroup",
27828 "field": "namedpickupgroup",
27835 "field": "language",
27842 "field": "tonezone",
27849 "field": "disallow",
27857 "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "alaw"]</p>"
27867 "field": "autoframing",
27874 "field": "insecure",
27875 "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"
27885 "field": "trustrpid",
27896 "field": "trust_id_outbound",
27908 "field": "progressinband",
27919 "field": "promiscredir",
27930 "field": "useclientcode",
27937 "field": "accountcode",
27951 "field": "callerid",
27958 "field": "amaflags",
27969 "field": "callcounter",
27976 "field": "busylevel",
27987 "field": "allowoverlap",
27998 "field": "allowsubscribe",
28009 "field": "allowtransfer",
28020 "field": "ignoresdpversion",
28027 "field": "subscribecontext",
28034 "field": "template",
28046 "field": "videosupport",
28053 "field": "maxcallbitrate",
28064 "field": "rfc2833compensate",
28071 "field": "mailbox",
28083 "field": "session_timers",
28090 "field": "session_expires",
28097 "field": "session_minse",
28108 "field": "session_refresher",
28115 "field": "t38pt_usertpsource",
28122 "field": "regexten",
28129 "field": "fromdomain",
28136 "field": "fromuser",
28154 "field": "qualify",
28161 "field": "keepalive",
28168 "field": "defaultip",
28175 "field": "defaultuser",
28182 "field": "rtptimeout",
28189 "field": "rtpholdtimeout",
28196 "field": "rtpkeepalive",
28208 "field": "sendrpid",
28215 "field": "outboundproxy",
28222 "field": "callbackextension",
28229 "field": "timert1",
28243 "field": "qualifyfreq",
28250 "field": "contactpermit",
28257 "field": "contactdeny",
28264 "field": "contactacl",
28271 "field": "unsolicited_mailbox",
28278 "field": "use_q850_reason",
28285 "field": "maxforwards",
28296 "field": "encryption",
28318 "field": "force_avp",
28329 "field": "icesupport",
28340 "field": "dtlsenable",
28353 "field": "dtlsverify",
28360 "field": "dtlsrekey",
28367 "field": "dtlscertfile",
28374 "field": "dtlsprivatekey",
28381 "field": "dtlscipher",
28388 "field": "dtlscafile",
28395 "field": "dtlscapath",
28407 "field": "dtlssetup",
28414 "field": "dtlsfingerprint",
28425 "field": "usereqphone",
28432 "field": "recordonfeature",
28439 "field": "recordofffeature",
28446 "field": "call_limit",
28457 "field": "registertrying",
28468 "field": "subscribemwi",
28475 "field": "vmexten",
28482 "field": "mohinterpret",
28489 "field": "mohsuggest",
28496 "field": "parkinglot",
28503 "field": "description",
28524 "field": "canreinvite",
28531 "field": "registry",
28538 "field": "otherFields",
28552 "field": "t38pt_udptl",
28558 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28559 "version": "0.0.0",
28560 "filename": "server/api/trunk/index.js",
28561 "groupTitle": "Trunks"
28565 "url": "/api/trunks/{id}",
28566 "title": "Deletes a trunk",
28569 "title": "Example usage:",
28570 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
28576 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28577 "version": "0.0.0",
28578 "filename": "server/api/trunk/index.js",
28579 "groupTitle": "Trunks"
28583 "url": "/api/trunks",
28584 "title": "Gets a list of Trunks",
28587 "title": "Example usage:",
28588 "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
28592 "name": "GetTrunks",
28594 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28595 "version": "0.0.0",
28596 "filename": "server/api/trunk/index.js",
28597 "groupTitle": "Trunks"
28601 "url": "/api/trunks/{id}",
28602 "title": "Gets a single Trunk",
28605 "title": "Example usage:",
28606 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
28610 "name": "ShowTrunks",
28612 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28613 "version": "0.0.0",
28614 "filename": "server/api/trunk/index.js",
28615 "groupTitle": "Trunks"
28619 "url": "/api/trunks/{id}",
28620 "title": "Update an existing trunk",
28623 "title": "Example usage:",
28624 "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
28630 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28631 "version": "0.0.0",
28632 "filename": "server/api/trunk/index.js",
28633 "groupTitle": "Trunks"
28637 "url": "/api/userNotifications",
28638 "title": "Send notification to user",
28641 "title": "Example usage:",
28642 "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28647 "group": "UserNotifications",
28648 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28649 "version": "0.0.0",
28650 "filename": "server/api/userNotification/index.js",
28651 "groupTitle": "UserNotifications"
28655 "url": "/api/userProfile/resources",
28656 "title": "Creates a new User Profile Resource",
28659 "title": "Example usage:",
28660 "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28664 "name": "CreateUser_Profile_Resources",
28665 "group": "User_Profile_Resources",
28680 "field": "resourceId",
28693 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28694 "version": "0.0.0",
28695 "filename": "server/api/userProfileResource/index.js",
28696 "groupTitle": "User_Profile_Resources"
28700 "url": "/api/userProfile/resources/{id}",
28701 "title": "Deletes a User Profile Resource",
28704 "title": "Example usage:",
28705 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
28709 "name": "DeleteUser_Profile_Resources",
28710 "group": "User_Profile_Resources",
28711 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28712 "version": "0.0.0",
28713 "filename": "server/api/userProfileResource/index.js",
28714 "groupTitle": "User_Profile_Resources"
28718 "url": "/api/userProfile/resources/describe",
28719 "title": "Gets table info about User Profile Resources",
28722 "title": "Example usage:",
28723 "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
28727 "name": "DescribeUser_Profile_Resources",
28728 "group": "User_Profile_Resources",
28729 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28730 "version": "0.0.0",
28731 "filename": "server/api/userProfileResource/index.js",
28732 "groupTitle": "User_Profile_Resources"
28736 "url": "/api/userProfile/resources",
28737 "title": "Gets a list of User Profile Resources",
28740 "title": "Example usage:",
28741 "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
28745 "name": "GetUser_Profile_Resources",
28746 "group": "User_Profile_Resources",
28747 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28748 "version": "0.0.0",
28749 "filename": "server/api/userProfileResource/index.js",
28750 "groupTitle": "User_Profile_Resources"
28754 "url": "/api/userProfile/resources/{id}",
28755 "title": "Gets a single User Profile Resource",
28758 "title": "Example usage:",
28759 "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
28763 "name": "ShowUser_Profile_Resources",
28764 "group": "User_Profile_Resources",
28765 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28766 "version": "0.0.0",
28767 "filename": "server/api/userProfileResource/index.js",
28768 "groupTitle": "User_Profile_Resources"
28772 "url": "/api/userProfile/resources/{id}",
28773 "title": "Update an existing User Profile Resource",
28776 "title": "Example usage:",
28777 "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",
28781 "name": "updateUser_Profile_Resources",
28782 "group": "User_Profile_Resources",
28783 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28784 "version": "0.0.0",
28785 "filename": "server/api/userProfileResource/index.js",
28786 "groupTitle": "User_Profile_Resources"
28790 "url": "/api/userProfile/sections",
28791 "title": "Creates a new User Profile Section",
28794 "title": "Example usage:",
28795 "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28799 "name": "CreateUser_Profile_Sections",
28800 "group": "User_Profile_Sections",
28815 "field": "category",
28822 "field": "sectionId",
28829 "field": "enabled",
28836 "field": "autoAssociation",
28843 "field": "crudPermissions",
28849 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28850 "version": "0.0.0",
28851 "filename": "server/api/userProfileSection/index.js",
28852 "groupTitle": "User_Profile_Sections"
28856 "url": "/api/userProfile/sections/{id}",
28857 "title": "Deletes a User Profile Section",
28860 "title": "Example usage:",
28861 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28865 "name": "DeleteUser_Profile_Sections",
28866 "group": "User_Profile_Sections",
28867 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28868 "version": "0.0.0",
28869 "filename": "server/api/userProfileSection/index.js",
28870 "groupTitle": "User_Profile_Sections"
28874 "url": "/api/userProfile/sections/describe",
28875 "title": "Gets table info about User Profile Sections",
28878 "title": "Example usage:",
28879 "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28883 "name": "DescribeUser_Profile_Sections",
28884 "group": "User_Profile_Sections",
28885 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28886 "version": "0.0.0",
28887 "filename": "server/api/userProfileSection/index.js",
28888 "groupTitle": "User_Profile_Sections"
28892 "url": "/api/userProfile/sections",
28893 "title": "Gets a list of User Profile Sections",
28896 "title": "Example usage:",
28897 "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28901 "name": "GetUser_Profile_Sections",
28902 "group": "User_Profile_Sections",
28903 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28904 "version": "0.0.0",
28905 "filename": "server/api/userProfileSection/index.js",
28906 "groupTitle": "User_Profile_Sections"
28910 "url": "/api/userProfile/sections/{id}",
28911 "title": "Gets a single User Profile Section",
28914 "title": "Example usage:",
28915 "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28919 "name": "ShowUser_Profile_Sections",
28920 "group": "User_Profile_Sections",
28921 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28922 "version": "0.0.0",
28923 "filename": "server/api/userProfileSection/index.js",
28924 "groupTitle": "User_Profile_Sections"
28928 "url": "/api/userProfile/sections/{id}",
28929 "title": "Update an existing User Profile Section",
28932 "title": "Example usage:",
28933 "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",
28937 "name": "updateUser_Profile_Sections",
28938 "group": "User_Profile_Sections",
28939 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28940 "version": "0.0.0",
28941 "filename": "server/api/userProfileSection/index.js",
28942 "groupTitle": "User_Profile_Sections"
28946 "url": "/api/userProfiles/{id}/resources",
28947 "title": "Add resources' permissions to User Profile",
28950 "title": "Example usage:",
28951 "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28955 "name": "AddResources",
28956 "group": "User_Profiles",
28957 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28958 "version": "0.0.0",
28959 "filename": "server/api/userProfile/index.js",
28960 "groupTitle": "User_Profiles"
28964 "url": "/api/userProfiles/{id}/sections",
28965 "title": "Add sections' permissions to User Profile",
28968 "title": "Example usage:",
28969 "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28973 "name": "AddSections",
28974 "group": "User_Profiles",
28975 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28976 "version": "0.0.0",
28977 "filename": "server/api/userProfile/index.js",
28978 "groupTitle": "User_Profiles"
28982 "url": "/api/userProfiles/clone",
28983 "title": "Clone an existing User Profile",
28986 "title": "Example usage:",
28987 "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28991 "name": "CloneUser_Profiles",
28992 "group": "User_Profiles",
28993 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28994 "version": "0.0.0",
28995 "filename": "server/api/userProfile/index.js",
28996 "groupTitle": "User_Profiles"
29000 "url": "/api/userProfiles",
29001 "title": "Creates a new User Profile",
29004 "title": "Example usage:",
29005 "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29009 "name": "CreateUser_Profiles",
29010 "group": "User_Profiles",
29025 "field": "crudPermissions",
29032 "field": "description",
29039 "field": "privacyEnabled",
29046 "field": "downloadAttachments",
29053 "field": "downloadCallySquareRecordings",
29060 "field": "downloadContactManagerLists",
29067 "field": "downloadJscriptySessions",
29074 "field": "downloadOmnichannelInteractions",
29081 "field": "downloadScreenRecordings",
29088 "field": "downloadVoiceRecordings",
29094 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29095 "version": "0.0.0",
29096 "filename": "server/api/userProfile/index.js",
29097 "groupTitle": "User_Profiles"
29101 "url": "/api/userProfiles/{id}",
29102 "title": "Deletes a User Profile",
29105 "title": "Example usage:",
29106 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
29110 "name": "DeleteUser_Profiles",
29111 "group": "User_Profiles",
29112 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29113 "version": "0.0.0",
29114 "filename": "server/api/userProfile/index.js",
29115 "groupTitle": "User_Profiles"
29119 "url": "/api/userProfiles/describe",
29120 "title": "Gets table info about User Profiles",
29123 "title": "Example usage:",
29124 "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
29128 "name": "DescribeUser_Profiles",
29129 "group": "User_Profiles",
29130 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29131 "version": "0.0.0",
29132 "filename": "server/api/userProfile/index.js",
29133 "groupTitle": "User_Profiles"
29137 "url": "/api/userProfiles/{id}/resources?section={section}",
29138 "title": "Get Resources assigned to a Section",
29141 "title": "Example usage:",
29142 "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
29146 "name": "GetResources",
29147 "group": "User_Profiles",
29148 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29149 "version": "0.0.0",
29150 "filename": "server/api/userProfile/index.js",
29151 "groupTitle": "User_Profiles"
29155 "url": "/api/userProfiles/{id}/sections",
29156 "title": "Get sections associated to a User Profile",
29159 "title": "Example usage:",
29160 "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
29164 "name": "GetSections",
29165 "group": "User_Profiles",
29166 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29167 "version": "0.0.0",
29168 "filename": "server/api/userProfile/index.js",
29169 "groupTitle": "User_Profiles"
29173 "url": "/api/userProfiles",
29174 "title": "Gets a list of User Profiles",
29177 "title": "Example usage:",
29178 "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
29182 "name": "GetUser_Profiles",
29183 "group": "User_Profiles",
29184 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29185 "version": "0.0.0",
29186 "filename": "server/api/userProfile/index.js",
29187 "groupTitle": "User_Profiles"
29191 "url": "/api/userProfiles/{id}/resources",
29192 "title": "Removes resources' permissions from User Profile",
29195 "title": "Example usage:",
29196 "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29200 "name": "RemoveResources",
29201 "group": "User_Profiles",
29202 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29203 "version": "0.0.0",
29204 "filename": "server/api/userProfile/index.js",
29205 "groupTitle": "User_Profiles"
29209 "url": "/api/userProfiles/{id}/sections",
29210 "title": "Removes sections' permissions from User Profile",
29213 "title": "Example usage:",
29214 "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29218 "name": "RemoveSections",
29219 "group": "User_Profiles",
29220 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29221 "version": "0.0.0",
29222 "filename": "server/api/userProfile/index.js",
29223 "groupTitle": "User_Profiles"
29227 "url": "/api/userProfiles/{id}",
29228 "title": "Gets a single User Profile",
29231 "title": "Example usage:",
29232 "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
29236 "name": "ShowUser_Profiles",
29237 "group": "User_Profiles",
29238 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29239 "version": "0.0.0",
29240 "filename": "server/api/userProfile/index.js",
29241 "groupTitle": "User_Profiles"
29245 "url": "/api/userProfiles/{id}",
29246 "title": "Update an existing User Profile",
29249 "title": "Example usage:",
29250 "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29254 "name": "updateUser_Profiles",
29255 "group": "User_Profiles",
29256 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29257 "version": "0.0.0",
29258 "filename": "server/api/userProfile/index.js",
29259 "groupTitle": "User_Profiles"
29263 "url": "/api/user-settings/{id}",
29264 "title": "Update an existing User Setting",
29267 "title": "Example usage:",
29268 "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",
29272 "name": "updateUserSettings",
29273 "group": "User_Settings",
29274 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29275 "version": "0.0.0",
29276 "filename": "server/api/user-setting/index.js",
29277 "groupTitle": "User_Settings"
29281 "url": "/api/users/{id}/chat_interactions",
29282 "title": "Add chat interaction tabs to an agent",
29285 "title": "Example usage:",
29286 "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",
29290 "name": "AddChatInteractions",
29292 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29293 "version": "0.0.0",
29294 "filename": "server/api/user/index.js",
29295 "groupTitle": "Users"
29299 "url": "/api/users/{id}/chat_websites",
29300 "title": "Add a Chat Website to a user",
29303 "title": "Example usage:",
29304 "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",
29308 "name": "AddChatWebsites",
29310 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29311 "version": "0.0.0",
29312 "filename": "server/api/user/index.js",
29313 "groupTitle": "Users"
29317 "url": "/api/users/{id}/contacts",
29318 "title": "Add contacts to a user",
29321 "title": "Example usage:",
29322 "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29326 "name": "AddContacts",
29328 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29329 "version": "0.0.0",
29330 "filename": "server/api/user/index.js",
29331 "groupTitle": "Users"
29335 "url": "/api/users/{id}/fax_accounts",
29336 "title": "Add a Fax Account to a user",
29339 "title": "Example usage:",
29340 "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",
29344 "name": "AddFaxAccounts",
29346 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29347 "version": "0.0.0",
29348 "filename": "server/api/user/index.js",
29349 "groupTitle": "Users"
29353 "url": "/api/users/{id}/fax_interactions",
29354 "title": "Add fax interaction tabs to an agent",
29357 "title": "Example usage:",
29358 "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",
29362 "name": "AddFaxInteractions",
29364 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29365 "version": "0.0.0",
29366 "filename": "server/api/user/index.js",
29367 "groupTitle": "Users"
29371 "url": "/api/users/{id}/mail_accounts",
29372 "title": "Add a Mail Account to a user",
29375 "title": "Example usage:",
29376 "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",
29380 "name": "AddMailAccounts",
29382 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29383 "version": "0.0.0",
29384 "filename": "server/api/user/index.js",
29385 "groupTitle": "Users"
29389 "url": "/api/users/{id}/mail_interactions",
29390 "title": "Add mail interaction tabs to an agent",
29393 "title": "Example usage:",
29394 "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",
29398 "name": "AddMailInteractions",
29400 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29401 "version": "0.0.0",
29402 "filename": "server/api/user/index.js",
29403 "groupTitle": "Users"
29407 "url": "/api/users/{id}/openchannel_accounts",
29408 "title": "Add a Open Channel Account to a user",
29411 "title": "Example usage:",
29412 "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",
29416 "name": "AddOpenchannelAccounts",
29418 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29419 "version": "0.0.0",
29420 "filename": "server/api/user/index.js",
29421 "groupTitle": "Users"
29425 "url": "/api/users/{id}/openchannel_interactions",
29426 "title": "Add openchannel interaction tabs to an agent",
29429 "title": "Example usage:",
29430 "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",
29434 "name": "AddOpenchannelInteractions",
29436 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29437 "version": "0.0.0",
29438 "filename": "server/api/user/index.js",
29439 "groupTitle": "Users"
29443 "url": "/api/users/{id}/queues",
29444 "title": "Add queues to an agent",
29447 "title": "Example usage:",
29448 "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",
29452 "name": "AddQueues",
29454 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29455 "version": "0.0.0",
29456 "filename": "server/api/user/index.js",
29457 "groupTitle": "Users"
29461 "url": "/api/users/{id}/sms_accounts",
29462 "title": "Add a Sms Account to a user",
29465 "title": "Example usage:",
29466 "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",
29470 "name": "AddSmsAccounts",
29472 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29473 "version": "0.0.0",
29474 "filename": "server/api/user/index.js",
29475 "groupTitle": "Users"
29479 "url": "/api/users/{id}/sms_interactions",
29480 "title": "Add sms interaction tabs to an agent",
29483 "title": "Example usage:",
29484 "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",
29488 "name": "AddSmsInteractions",
29490 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29491 "version": "0.0.0",
29492 "filename": "server/api/user/index.js",
29493 "groupTitle": "Users"
29497 "url": "/api/users/{id}/teams",
29498 "title": "Add teams to an agent",
29501 "title": "Example usage:",
29502 "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29506 "name": "AddTeams",
29508 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29509 "version": "0.0.0",
29510 "filename": "server/api/user/index.js",
29511 "groupTitle": "Users"
29515 "url": "/api/users/{id}/whatsapp_accounts",
29516 "title": "Add a Whatsapp Account to a user",
29519 "title": "Example usage:",
29520 "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",
29524 "name": "AddWhatsappAccounts",
29526 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29527 "version": "0.0.0",
29528 "filename": "server/api/user/index.js",
29529 "groupTitle": "Users"
29533 "url": "/api/users/{id}/whatsapp_interactions",
29534 "title": "Add Whatsapp interaction tabs to an agent",
29537 "title": "Example usage:",
29538 "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",
29542 "name": "AddWhatsappInteractions",
29544 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29545 "version": "0.0.0",
29546 "filename": "server/api/user/index.js",
29547 "groupTitle": "Users"
29551 "url": "/api/users/{id}/password",
29552 "title": "Change user password",
29555 "title": "Example usage:",
29556 "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",
29560 "name": "ChangePwd",
29562 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29563 "version": "0.0.0",
29564 "filename": "server/api/user/index.js",
29565 "groupTitle": "Users"
29569 "url": "/api/users",
29570 "title": "Create a new user",
29573 "title": "Example usage:",
29574 "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29580 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29581 "version": "0.0.0",
29582 "filename": "server/api/user/index.js",
29583 "groupTitle": "Users"
29587 "url": "/api/users/{id}/api_key",
29588 "title": "Create a new API access key for the user",
29591 "title": "Example usage:",
29592 "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29596 "name": "CreateApiKey",
29598 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29599 "version": "0.0.0",
29600 "filename": "server/api/user/index.js",
29601 "groupTitle": "Users"
29605 "url": "/api/users/{id}",
29606 "title": "Deletes a user",
29609 "title": "Example usage:",
29610 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
29616 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29617 "version": "0.0.0",
29618 "filename": "server/api/user/index.js",
29619 "groupTitle": "Users"
29623 "url": "/api/users/describe",
29624 "title": "Gets table info about Users",
29627 "title": "Example usage:",
29628 "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
29632 "name": "DescribeUsers",
29634 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29635 "version": "0.0.0",
29636 "filename": "server/api/user/index.js",
29637 "groupTitle": "Users"
29641 "url": "/api/users/{id}/agents",
29642 "title": "GetAgents",
29645 "title": "Example usage:",
29646 "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
29650 "name": "GetAgents",
29652 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29653 "version": "0.0.0",
29654 "filename": "server/api/user/index.js",
29655 "groupTitle": "Users"
29659 "url": "/api/users/{id}/api_key",
29660 "title": "Get the API access key for the user",
29663 "title": "Example usage:",
29664 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
29668 "name": "GetApiKey",
29670 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29671 "version": "0.0.0",
29672 "filename": "server/api/user/index.js",
29673 "groupTitle": "Users"
29677 "url": "/api/users/{id}/groups",
29678 "title": "GetChatGroups",
29681 "title": "Example usage:",
29682 "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
29686 "name": "GetChatGroups",
29688 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29689 "version": "0.0.0",
29690 "filename": "server/api/user/index.js",
29691 "groupTitle": "Users"
29695 "url": "/api/users/{id}/chat/interactions",
29696 "title": "GetChatInteractions",
29699 "title": "Example usage:",
29700 "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
29704 "name": "GetChatInteractions",
29706 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29707 "version": "0.0.0",
29708 "filename": "server/api/user/index.js",
29709 "groupTitle": "Users"
29713 "url": "/api/users/{id}/chat_websites",
29714 "title": "GetChatWebsites",
29717 "title": "Example usage:",
29718 "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
29722 "name": "GetChatWebsites",
29724 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29725 "version": "0.0.0",
29726 "filename": "server/api/user/index.js",
29727 "groupTitle": "Users"
29731 "url": "/api/users/{id}/contacts",
29732 "title": "GetContacts",
29735 "title": "Example usage:",
29736 "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
29740 "name": "GetContacts",
29742 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29743 "version": "0.0.0",
29744 "filename": "server/api/user/index.js",
29745 "groupTitle": "Users"
29749 "url": "/api/users/{id}/fax_accounts",
29750 "title": "GetFaxAccounts",
29753 "title": "Example usage:",
29754 "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
29758 "name": "GetFaxAccounts",
29760 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29761 "version": "0.0.0",
29762 "filename": "server/api/user/index.js",
29763 "groupTitle": "Users"
29767 "url": "/api/users/{id}/fax/interactions",
29768 "title": "GetFaxInteractions",
29771 "title": "Example usage:",
29772 "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
29776 "name": "GetFaxInteractions",
29778 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29779 "version": "0.0.0",
29780 "filename": "server/api/user/index.js",
29781 "groupTitle": "Users"
29785 "url": "/api/users/{id}/lists",
29786 "title": "GetLists",
29789 "title": "Example usage:",
29790 "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
29794 "name": "GetLists",
29796 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29797 "version": "0.0.0",
29798 "filename": "server/api/user/index.js",
29799 "groupTitle": "Users"
29803 "url": "/api/users/{id}/mail_accounts",
29804 "title": "GetMailAccounts",
29807 "title": "Example usage:",
29808 "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29812 "name": "GetMailAccounts",
29814 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29815 "version": "0.0.0",
29816 "filename": "server/api/user/index.js",
29817 "groupTitle": "Users"
29821 "url": "/api/users/{id}/mail/interactions",
29822 "title": "GetMailInteractions",
29825 "title": "Example usage:",
29826 "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29830 "name": "GetMailInteractions",
29832 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29833 "version": "0.0.0",
29834 "filename": "server/api/user/index.js",
29835 "groupTitle": "Users"
29839 "url": "/api/users/{id}/openchannel_accounts",
29840 "title": "GetOpenchannelAccounts",
29843 "title": "Example usage:",
29844 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29848 "name": "GetOpenchannelAccounts",
29850 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29851 "version": "0.0.0",
29852 "filename": "server/api/user/index.js",
29853 "groupTitle": "Users"
29857 "url": "/api/users/{id}/openchannel/interactions",
29858 "title": "GetOpenchannelInteractions",
29861 "title": "Example usage:",
29862 "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29866 "name": "GetOpenchannelInteractions",
29868 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29869 "version": "0.0.0",
29870 "filename": "server/api/user/index.js",
29871 "groupTitle": "Users"
29875 "url": "/api/users/{id}/prefixes",
29876 "title": "GetPrefixes",
29879 "title": "Example usage:",
29880 "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29884 "name": "GetPrefixes",
29886 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29887 "version": "0.0.0",
29888 "filename": "server/api/user/index.js",
29889 "groupTitle": "Users"
29893 "url": "/api/users/{id}/queues?channel={channel}",
29894 "title": "Gets Queues list",
29897 "title": "Example usage:",
29898 "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29902 "name": "GetQueues",
29904 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29905 "version": "0.0.0",
29906 "filename": "server/api/user/index.js",
29907 "groupTitle": "Users"
29911 "url": "/api/users/{id}/recordings",
29912 "title": "GetRecordings",
29915 "title": "Example usage:",
29916 "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29920 "name": "GetRecordings",
29922 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29923 "version": "0.0.0",
29924 "filename": "server/api/user/index.js",
29925 "groupTitle": "Users"
29929 "url": "/api/users/{id}/scheduled_calls",
29930 "title": "GetScheduledCalls",
29933 "title": "Example usage:",
29934 "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29938 "name": "GetScheduledCalls",
29940 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29941 "version": "0.0.0",
29942 "filename": "server/api/user/index.js",
29943 "groupTitle": "Users"
29947 "url": "/api/users/{id}/screen_recordings",
29948 "title": "GetScreenRecordings",
29951 "title": "Example usage:",
29952 "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29956 "name": "GetScreenRecordings",
29958 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29959 "version": "0.0.0",
29960 "filename": "server/api/user/index.js",
29961 "groupTitle": "Users"
29965 "url": "/api/users/{id}/sms_accounts",
29966 "title": "GetSmsAccounts",
29969 "title": "Example usage:",
29970 "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29974 "name": "GetSmsAccounts",
29976 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29977 "version": "0.0.0",
29978 "filename": "server/api/user/index.js",
29979 "groupTitle": "Users"
29983 "url": "/api/users/{id}/sms/interactions",
29984 "title": "GetSmsInteractions",
29987 "title": "Example usage:",
29988 "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29992 "name": "GetSmsInteractions",
29994 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29995 "version": "0.0.0",
29996 "filename": "server/api/user/index.js",
29997 "groupTitle": "Users"
30001 "url": "/api/users/{id}/teams",
30002 "title": "GetTeams",
30005 "title": "Example usage:",
30006 "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
30010 "name": "GetTeams",
30012 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30013 "version": "0.0.0",
30014 "filename": "server/api/user/index.js",
30015 "groupTitle": "Users"
30019 "url": "/api/users",
30020 "title": "Gets a list of Users",
30023 "title": "Example usage:",
30024 "content": "curl https://{domain}/api/users -v -u {name}:{password}",
30028 "name": "GetUsers",
30030 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30031 "version": "0.0.0",
30032 "filename": "server/api/user/index.js",
30033 "groupTitle": "Users"
30037 "url": "/api/users/{id}/queues_rt",
30038 "title": "GetVoiceQueuesRt",
30041 "title": "Example usage:",
30042 "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
30046 "name": "GetVoiceQueuesRt",
30048 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30049 "version": "0.0.0",
30050 "filename": "server/api/user/index.js",
30051 "groupTitle": "Users"
30055 "url": "/api/users/{id}/whatsapp_accounts",
30056 "title": "GetWhatsappAccounts",
30059 "title": "Example usage:",
30060 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
30064 "name": "GetWhatsappAccounts",
30066 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30067 "version": "0.0.0",
30068 "filename": "server/api/user/index.js",
30069 "groupTitle": "Users"
30073 "url": "/api/users/{id}/whatsapp/interactions",
30074 "title": "GetWhatsappInteractions",
30077 "title": "Example usage:",
30078 "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
30082 "name": "GetWhatsappInteractions",
30084 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30085 "version": "0.0.0",
30086 "filename": "server/api/user/index.js",
30087 "groupTitle": "Users"
30091 "url": "/api/users/{id}/login",
30095 "title": "Example usage:",
30096 "content": "curl https://{domain}/api/users/{id}/login -v -u {name}:{password} -X POST",
30102 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30103 "version": "0.0.0",
30104 "filename": "server/api/user/index.js",
30105 "groupTitle": "Users"
30109 "url": "/api/users/{id}/logout",
30113 "title": "Example usage:",
30114 "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
30120 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30121 "version": "0.0.0",
30122 "filename": "server/api/user/index.js",
30123 "groupTitle": "Users"
30127 "url": "/api/users/{id}/pause",
30131 "title": "Example usage:",
30132 "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
30138 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30139 "version": "0.0.0",
30140 "filename": "server/api/user/index.js",
30141 "groupTitle": "Users"
30145 "url": "/api/users/{id}/api_key",
30146 "title": "Remove API access key for the user",
30149 "title": "Example usage:",
30150 "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
30154 "name": "RemoveApiKey",
30156 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30157 "version": "0.0.0",
30158 "filename": "server/api/user/index.js",
30159 "groupTitle": "Users"
30163 "url": "/api/users/{id}/chat_interactions",
30164 "title": "Removes interactions from an agent",
30167 "title": "Example usage:",
30168 "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30172 "name": "RemoveChatInteractions",
30174 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30175 "version": "0.0.0",
30176 "filename": "server/api/user/index.js",
30177 "groupTitle": "Users"
30181 "url": "/api/users/{id}/chat_websites",
30182 "title": "Removes a Chat Website from a user",
30185 "title": "Example usage:",
30186 "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30190 "name": "RemoveChatWebsites",
30192 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30193 "version": "0.0.0",
30194 "filename": "server/api/user/index.js",
30195 "groupTitle": "Users"
30199 "url": "/api/users/{id}/fax_accounts",
30200 "title": "Removes a Fax Account from a user",
30203 "title": "Example usage:",
30204 "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30208 "name": "RemoveFaxAccounts",
30210 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30211 "version": "0.0.0",
30212 "filename": "server/api/user/index.js",
30213 "groupTitle": "Users"
30217 "url": "/api/users/{id}/fax_interactions",
30218 "title": "Removes interactions from an agent",
30221 "title": "Example usage:",
30222 "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30226 "name": "RemoveFaxInteractions",
30228 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30229 "version": "0.0.0",
30230 "filename": "server/api/user/index.js",
30231 "groupTitle": "Users"
30235 "url": "/api/users/{id}/mail_accounts",
30236 "title": "Removes a Mail Account from a user",
30239 "title": "Example usage:",
30240 "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30244 "name": "RemoveMailAccounts",
30246 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30247 "version": "0.0.0",
30248 "filename": "server/api/user/index.js",
30249 "groupTitle": "Users"
30253 "url": "/api/users/{id}/mail_interactions",
30254 "title": "Removes interactions from an agent",
30257 "title": "Example usage:",
30258 "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30262 "name": "RemoveMailInteractions",
30264 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30265 "version": "0.0.0",
30266 "filename": "server/api/user/index.js",
30267 "groupTitle": "Users"
30271 "url": "/api/users/{id}/openchannel_accounts",
30272 "title": "Removes a Open Channel Account from a user",
30275 "title": "Example usage:",
30276 "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30280 "name": "RemoveOpenchannelAccounts",
30282 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30283 "version": "0.0.0",
30284 "filename": "server/api/user/index.js",
30285 "groupTitle": "Users"
30289 "url": "/api/users/{id}/openchannel_interactions",
30290 "title": "Removes openchannel interactions from an agent",
30293 "title": "Example usage:",
30294 "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30298 "name": "RemoveOpenchannelInteractions",
30300 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30301 "version": "0.0.0",
30302 "filename": "server/api/user/index.js",
30303 "groupTitle": "Users"
30307 "url": "/api/users/{id}/queues",
30308 "title": "Remove queues to an agent",
30311 "title": "Example usage:",
30312 "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30316 "name": "RemoveQueues",
30318 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30319 "version": "0.0.0",
30320 "filename": "server/api/user/index.js",
30321 "groupTitle": "Users"
30325 "url": "/api/users/{id}/sms_accounts",
30326 "title": "Removes a Sms Account from a user",
30329 "title": "Example usage:",
30330 "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30334 "name": "RemoveSmsAccounts",
30336 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30337 "version": "0.0.0",
30338 "filename": "server/api/user/index.js",
30339 "groupTitle": "Users"
30343 "url": "/api/users/{id}/sms_interactions",
30344 "title": "Removes interactions from an agent",
30347 "title": "Example usage:",
30348 "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30352 "name": "RemoveSmsInteractions",
30354 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30355 "version": "0.0.0",
30356 "filename": "server/api/user/index.js",
30357 "groupTitle": "Users"
30361 "url": "/api/users/{id}/teams",
30362 "title": "Removes teams from an agent",
30365 "title": "Example usage:",
30366 "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30370 "name": "RemoveTeams",
30372 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30373 "version": "0.0.0",
30374 "filename": "server/api/user/index.js",
30375 "groupTitle": "Users"
30379 "url": "/api/users/{id}/whatsapp_accounts",
30380 "title": "Removes a Whatsapp Account from a user",
30383 "title": "Example usage:",
30384 "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30388 "name": "RemoveWhatsappAccounts",
30390 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30391 "version": "0.0.0",
30392 "filename": "server/api/user/index.js",
30393 "groupTitle": "Users"
30397 "url": "/api/users/{id}/whatsapp_interactions",
30398 "title": "Removes Whatsapp interactions from an agent",
30401 "title": "Example usage:",
30402 "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30406 "name": "RemoveWhatsappInteractions",
30408 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30409 "version": "0.0.0",
30410 "filename": "server/api/user/index.js",
30411 "groupTitle": "Users"
30415 "url": "/api/users/{id}",
30416 "title": "Gets a single User",
30419 "title": "Example usage:",
30420 "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
30424 "name": "ShowUsers",
30426 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30427 "version": "0.0.0",
30428 "filename": "server/api/user/index.js",
30429 "groupTitle": "Users"
30433 "url": "/api/users/{id}/unpause",
30434 "title": "Unpause",
30437 "title": "Example usage:",
30438 "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
30444 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30445 "version": "0.0.0",
30446 "filename": "server/api/user/index.js",
30447 "groupTitle": "Users"
30451 "url": "/api/users/whoami",
30455 "title": "Example usage:",
30456 "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
30462 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30463 "version": "0.0.0",
30464 "filename": "server/api/user/index.js",
30465 "groupTitle": "Users"
30469 "url": "/api/users/{id}/avatar",
30470 "title": "Add avatar",
30473 "title": "Example usage:",
30474 "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
30478 "name": "addAvatar",
30480 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30481 "version": "0.0.0",
30482 "filename": "server/api/user/index.js",
30483 "groupTitle": "Users"
30487 "url": "/api/users/create_many",
30488 "title": "Create Users",
30491 "title": "Example usage:",
30492 "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
30496 "name": "bulkCreate",
30498 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30499 "version": "0.0.0",
30500 "filename": "server/api/user/index.js",
30501 "groupTitle": "Users"
30505 "url": "/api/users/{id}/avatar",
30506 "title": "Get avatar",
30509 "title": "Example usage:",
30510 "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
30514 "name": "getAvatar",
30516 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30517 "version": "0.0.0",
30518 "filename": "server/api/user/index.js",
30519 "groupTitle": "Users"
30523 "url": "/api/users/{id}/open_tabs",
30524 "title": "Get interactions opened tabs",
30527 "title": "Example usage:",
30528 "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
30532 "name": "getOpenTabs",
30534 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30535 "version": "0.0.0",
30536 "filename": "server/api/user/index.js",
30537 "groupTitle": "Users"
30541 "url": "/api/users/presence",
30542 "title": "Gets agent presence",
30545 "title": "Example usage:",
30546 "content": "curl https://{domain}/api/users/presence -v -u {name}:{password} -X GET",
30550 "name": "getPresence",
30552 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30553 "version": "0.0.0",
30554 "filename": "server/api/user/index.js",
30555 "groupTitle": "Users"
30559 "url": "/api/users/{id}",
30560 "title": "Update an existing User",
30563 "title": "Example usage:",
30564 "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30568 "name": "updateUsers",
30570 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30571 "version": "0.0.0",
30572 "filename": "server/api/user/index.js",
30573 "groupTitle": "Users"
30577 "url": "/api/variables",
30578 "title": "Creates a new Variable",
30581 "title": "Example usage:",
30582 "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30586 "name": "CreateVariables",
30587 "group": "Variables",
30602 "field": "description",
30608 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30609 "version": "0.0.0",
30610 "filename": "server/api/variable/index.js",
30611 "groupTitle": "Variables"
30615 "url": "/api/variables/{id}",
30616 "title": "Deletes a Variable",
30619 "title": "Example usage:",
30620 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
30624 "name": "DeleteVariables",
30625 "group": "Variables",
30626 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30627 "version": "0.0.0",
30628 "filename": "server/api/variable/index.js",
30629 "groupTitle": "Variables"
30633 "url": "/api/variables",
30634 "title": "Gets a list of Variables",
30637 "title": "Example usage:",
30638 "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
30642 "name": "GetVariables",
30643 "group": "Variables",
30644 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30645 "version": "0.0.0",
30646 "filename": "server/api/variable/index.js",
30647 "groupTitle": "Variables"
30651 "url": "/api/variables/{id}",
30652 "title": "Gets a single Variable",
30655 "title": "Example usage:",
30656 "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
30660 "name": "ShowVariables",
30661 "group": "Variables",
30662 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30663 "version": "0.0.0",
30664 "filename": "server/api/variable/index.js",
30665 "groupTitle": "Variables"
30669 "url": "/api/variables/{id}",
30670 "title": "Update an existing Variable",
30673 "title": "Example usage:",
30674 "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30678 "name": "updateVariables",
30679 "group": "Variables",
30680 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30681 "version": "0.0.0",
30682 "filename": "server/api/variable/index.js",
30683 "groupTitle": "Variables"
30687 "url": "/api/version/fetch",
30688 "title": "Fetch git version",
30691 "title": "Example usage:",
30692 "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
30696 "name": "FetchVersion",
30697 "group": "Version",
30698 "description": "<p>Motion run the following command: git fetch origin master</p>",
30699 "version": "0.0.0",
30700 "filename": "server/api/version/index.js",
30701 "groupTitle": "Version"
30705 "url": "/api/version",
30706 "title": "Gets version",
30709 "title": "Example usage:",
30710 "content": "curl https://{domain}/api/version -v -u {name}:{password}",
30714 "name": "GetVersion",
30715 "group": "Version",
30716 "description": "<p>Motion returns the current and latest motion version.</p>",
30717 "version": "0.0.0",
30718 "filename": "server/api/version/index.js",
30719 "groupTitle": "Version"
30723 "url": "/api/version/migrations",
30724 "title": "Launch database migrations",
30727 "title": "Example usage:",
30728 "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
30732 "name": "MigrateVersion",
30733 "group": "Version",
30734 "description": "<p>Motion launch the database migrations, according to the application version</p>",
30735 "version": "0.0.0",
30736 "filename": "server/api/version/index.js",
30737 "groupTitle": "Version"
30741 "url": "/api/version/pull",
30742 "title": "Pull git version",
30745 "title": "Example usage:",
30746 "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
30750 "name": "PullVersion",
30751 "group": "Version",
30752 "description": "<p>Motion run the following command: git pull</p>",
30753 "version": "0.0.0",
30754 "filename": "server/api/version/index.js",
30755 "groupTitle": "Version"
30759 "url": "/api/version/reset",
30760 "title": "Reset git version",
30763 "title": "Example usage:",
30764 "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30768 "name": "ResetVersion",
30769 "group": "Version",
30770 "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
30771 "version": "0.0.0",
30772 "filename": "server/api/version/index.js",
30773 "groupTitle": "Version"
30777 "url": "/api/version/restart",
30778 "title": "Restart motion2 after update",
30781 "title": "Example usage:",
30782 "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30786 "name": "RestartVersion",
30787 "group": "Version",
30788 "description": "<p>Motion run the following command: pm2 restart motion</p>",
30789 "version": "0.0.0",
30790 "filename": "server/api/version/index.js",
30791 "groupTitle": "Version"
30795 "url": "/api/voice/agents/reports/describe",
30796 "title": "Gets table info about Agent Reports",
30799 "title": "Example usage:",
30800 "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30804 "name": "DescribeAgent_Reports",
30805 "group": "Voice_Agent_Reports",
30806 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30807 "version": "0.0.0",
30808 "filename": "server/api/voiceAgentReport/index.js",
30809 "groupTitle": "Voice_Agent_Reports"
30813 "url": "/api/voice/agents/reports",
30814 "title": "Gets a list of Agent Reports",
30817 "title": "Example usage:",
30818 "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30822 "name": "GetAgent_Reports",
30823 "group": "Voice_Agent_Reports",
30824 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30825 "version": "0.0.0",
30826 "filename": "server/api/voiceAgentReport/index.js",
30827 "groupTitle": "Voice_Agent_Reports"
30831 "url": "/api/voice/agents/reports/{id}",
30832 "title": "Gets a single Agent Report",
30835 "title": "Example usage:",
30836 "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30840 "name": "ShowAgent_Reports",
30841 "group": "Voice_Agent_Reports",
30842 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30843 "version": "0.0.0",
30844 "filename": "server/api/voiceAgentReport/index.js",
30845 "groupTitle": "Voice_Agent_Reports"
30849 "url": "/api/voice/calls/reports/describe",
30850 "title": "Gets table info about Call Reports",
30853 "title": "Example usage:",
30854 "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30858 "name": "DescribeCall_Reports",
30859 "group": "Voice_Call_Reports",
30860 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30861 "version": "0.0.0",
30862 "filename": "server/api/voiceCallReport/index.js",
30863 "groupTitle": "Voice_Call_Reports"
30867 "url": "/api/voice/calls/reports",
30868 "title": "Gets a list of Call Reports",
30871 "title": "Example usage:",
30872 "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30876 "name": "GetCall_Reports",
30877 "group": "Voice_Call_Reports",
30878 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30879 "version": "0.0.0",
30880 "filename": "server/api/voiceCallReport/index.js",
30881 "groupTitle": "Voice_Call_Reports"
30885 "url": "/api/voice/calls/reports/{id}",
30886 "title": "Gets a single Call Report",
30889 "title": "Example usage:",
30890 "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30894 "name": "ShowCall_Reports",
30895 "group": "Voice_Call_Reports",
30896 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30897 "version": "0.0.0",
30898 "filename": "server/api/voiceCallReport/index.js",
30899 "groupTitle": "Voice_Call_Reports"
30903 "url": "/api/voice/calls/reports/{id}",
30904 "title": "Update a single cdr",
30907 "title": "Example usage:",
30908 "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30913 "group": "Voice_Call_Reports",
30914 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30915 "version": "0.0.0",
30916 "filename": "server/api/voiceCallReport/index.js",
30917 "groupTitle": "Voice_Call_Reports"
30921 "url": "/api/voice/chanspy",
30922 "title": "Creates a new ChanSpy",
30925 "title": "Example usage:",
30926 "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30930 "name": "CreateChanSpy",
30931 "group": "Voice_ChanSpy",
30953 "field": "options",
30967 "field": "password",
30981 "field": "recordingFormat",
30988 "field": "description",
30994 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30995 "version": "0.0.0",
30996 "filename": "server/api/voiceChanSpy/index.js",
30997 "groupTitle": "Voice_ChanSpy"
31001 "url": "/api/voice/chanspy/{id}",
31002 "title": "Deletes a ChanSpy",
31005 "title": "Example usage:",
31006 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
31010 "name": "DeleteChanSpy",
31011 "group": "Voice_ChanSpy",
31012 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31013 "version": "0.0.0",
31014 "filename": "server/api/voiceChanSpy/index.js",
31015 "groupTitle": "Voice_ChanSpy"
31019 "url": "/api/voice/chanspy",
31020 "title": "Gets a list of ChanSpy",
31023 "title": "Example usage:",
31024 "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
31028 "name": "GetChanSpy",
31029 "group": "Voice_ChanSpy",
31030 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31031 "version": "0.0.0",
31032 "filename": "server/api/voiceChanSpy/index.js",
31033 "groupTitle": "Voice_ChanSpy"
31037 "url": "/api/voice/chanspy/{id}",
31038 "title": "Gets a single ChanSpy",
31041 "title": "Example usage:",
31042 "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
31046 "name": "ShowChanSpy",
31047 "group": "Voice_ChanSpy",
31048 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31049 "version": "0.0.0",
31050 "filename": "server/api/voiceChanSpy/index.js",
31051 "groupTitle": "Voice_ChanSpy"
31055 "url": "/api/voice/chanspy/{id}",
31056 "title": "Update an existing ChanSpy",
31059 "title": "Example usage:",
31060 "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",
31064 "name": "updateChanSpy",
31065 "group": "Voice_ChanSpy",
31066 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31067 "version": "0.0.0",
31068 "filename": "server/api/voiceChanSpy/index.js",
31069 "groupTitle": "Voice_ChanSpy"
31073 "url": "/api/voice/contexts",
31074 "title": "Create a new context",
31077 "title": "Example usage:",
31078 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
31083 "group": "Voice_Contexts",
31098 "field": "description",
31105 "field": "defaultEntry",
31111 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31112 "version": "0.0.0",
31113 "filename": "server/api/voiceContext/index.js",
31114 "groupTitle": "Voice_Contexts"
31118 "url": "/api/voice/contexts/{id}",
31119 "title": "Deletes a context",
31122 "title": "Example usage:",
31123 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
31128 "group": "Voice_Contexts",
31129 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31130 "version": "0.0.0",
31131 "filename": "server/api/voiceContext/index.js",
31132 "groupTitle": "Voice_Contexts"
31136 "url": "/api/voice/contexts",
31137 "title": "Gets a list of Contexts",
31140 "title": "Example usage:",
31141 "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
31145 "name": "GetContexts",
31146 "group": "Voice_Contexts",
31147 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31148 "version": "0.0.0",
31149 "filename": "server/api/voiceContext/index.js",
31150 "groupTitle": "Voice_Contexts"
31154 "url": "/api/voice/contexts/{id}",
31155 "title": "Gets a single Context",
31158 "title": "Example usage:",
31159 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
31163 "name": "ShowContexts",
31164 "group": "Voice_Contexts",
31165 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31166 "version": "0.0.0",
31167 "filename": "server/api/voiceContext/index.js",
31168 "groupTitle": "Voice_Contexts"
31172 "url": "/api/voice/contexts/{id}",
31173 "title": "Update an existing context",
31176 "title": "Example usage:",
31177 "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
31182 "group": "Voice_Contexts",
31183 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31184 "version": "0.0.0",
31185 "filename": "server/api/voiceContext/index.js",
31186 "groupTitle": "Voice_Contexts"
31190 "url": "/api/voice/dials/reports/describe",
31191 "title": "Gets table info about Dial Reports",
31194 "title": "Example usage:",
31195 "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
31199 "name": "DescribeDial_Reports",
31200 "group": "Voice_Dial_Reports",
31201 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31202 "version": "0.0.0",
31203 "filename": "server/api/voiceDialReport/index.js",
31204 "groupTitle": "Voice_Dial_Reports"
31208 "url": "/api/voice/dials/reports",
31209 "title": "Gets a list of Dial Reports",
31212 "title": "Example usage:",
31213 "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
31217 "name": "GetDial_Reports",
31218 "group": "Voice_Dial_Reports",
31219 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31220 "version": "0.0.0",
31221 "filename": "server/api/voiceDialReport/index.js",
31222 "groupTitle": "Voice_Dial_Reports"
31226 "url": "/api/voice/dials/reports/{id}",
31227 "title": "Gets a single Dial Report",
31230 "title": "Example usage:",
31231 "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
31235 "name": "ShowDial_Reports",
31236 "group": "Voice_Dial_Reports",
31237 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31238 "version": "0.0.0",
31239 "filename": "server/api/voiceDialReport/index.js",
31240 "groupTitle": "Voice_Dial_Reports"
31244 "url": "/api/voice/extensions/{id}",
31245 "title": "Deletes a Extension",
31248 "title": "Example usage:",
31249 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
31253 "name": "DeleteExtensions",
31254 "group": "Voice_Extensions",
31255 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31256 "version": "0.0.0",
31257 "filename": "server/api/voiceExtension/index.js",
31258 "groupTitle": "Voice_Extensions"
31262 "url": "/api/voice/extensions",
31263 "title": "Gets a list of Extensions",
31266 "title": "Example usage:",
31267 "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
31271 "name": "GetExtensions",
31272 "group": "Voice_Extensions",
31273 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31274 "version": "0.0.0",
31275 "filename": "server/api/voiceExtension/index.js",
31276 "groupTitle": "Voice_Extensions"
31280 "url": "/api/voice/extensions/{id}",
31281 "title": "Gets a single Extension",
31284 "title": "Example usage:",
31285 "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
31289 "name": "ShowExtensions",
31290 "group": "Voice_Extensions",
31291 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31292 "version": "0.0.0",
31293 "filename": "server/api/voiceExtension/index.js",
31294 "groupTitle": "Voice_Extensions"
31298 "url": "/api/voice/extensions",
31299 "title": "Create new applications",
31302 "title": "Example usage:",
31303 "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",
31307 "name": "addApplications",
31308 "group": "Voice_Extensions",
31309 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31310 "version": "0.0.0",
31311 "filename": "server/api/voiceExtension/index.js",
31312 "groupTitle": "Voice_Extensions"
31316 "url": "/api/voice/extensions",
31317 "title": "Create an extension",
31320 "title": "Example usage:",
31321 "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31326 "group": "Voice_Extensions",
31327 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31328 "version": "0.0.0",
31329 "filename": "server/api/voiceExtension/index.js",
31330 "groupTitle": "Voice_Extensions"
31334 "url": "/api/voice/extensions/{id}",
31335 "title": "Update an extension",
31338 "title": "Example usage:",
31339 "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",
31344 "group": "Voice_Extensions",
31345 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31346 "version": "0.0.0",
31347 "filename": "server/api/voiceExtension/index.js",
31348 "groupTitle": "Voice_Extensions"
31352 "url": "/api/voice/mohs",
31353 "title": "Create a new a new MOH",
31356 "title": "Example usage:",
31357 "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31362 "group": "Voice_MOHs",
31363 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31364 "version": "0.0.0",
31365 "filename": "server/api/voiceMusicOnHold/index.js",
31366 "groupTitle": "Voice_MOHs"
31370 "url": "/api/voice/mohs/{id}/sounds",
31371 "title": "Add sound to MOH",
31374 "title": "Example usage:",
31375 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31379 "name": "AddSound",
31380 "group": "Voice_MOHs",
31381 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31382 "version": "0.0.0",
31383 "filename": "server/api/voiceMusicOnHold/index.js",
31384 "groupTitle": "Voice_MOHs"
31388 "url": "/api/voice/mohs/{id}",
31389 "title": "Deletes an MOH",
31392 "title": "Example usage:",
31393 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
31397 "name": "DestroyMoh",
31398 "group": "Voice_MOHs",
31399 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31400 "version": "0.0.0",
31401 "filename": "server/api/voiceMusicOnHold/index.js",
31402 "groupTitle": "Voice_MOHs"
31406 "url": "/api/voice/mohs",
31407 "title": "Gets a list of Music On Holds",
31410 "title": "Example usage:",
31411 "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
31415 "name": "GetMusic_On_Holds",
31416 "group": "Voice_MOHs",
31417 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31418 "version": "0.0.0",
31419 "filename": "server/api/voiceMusicOnHold/index.js",
31420 "groupTitle": "Voice_MOHs"
31424 "url": "/api/voice/mohs/{id}/sounds",
31425 "title": "Gets sounds from MOH",
31428 "title": "Example usage:",
31429 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
31433 "name": "GetSounds",
31434 "group": "Voice_MOHs",
31435 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31436 "version": "0.0.0",
31437 "filename": "server/api/voiceMusicOnHold/index.js",
31438 "groupTitle": "Voice_MOHs"
31442 "url": "/api/voice/mohs/{id}/sounds/{id2}",
31443 "title": "Remove sound from MOH",
31446 "title": "Example usage:",
31447 "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
31451 "name": "RemoveSound",
31452 "group": "Voice_MOHs",
31453 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31454 "version": "0.0.0",
31455 "filename": "server/api/voiceMusicOnHold/index.js",
31456 "groupTitle": "Voice_MOHs"
31460 "url": "/api/voice/mohs/{id}",
31461 "title": "Gets a single Music On Hold",
31464 "title": "Example usage:",
31465 "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
31469 "name": "ShowMusic_On_Holds",
31470 "group": "Voice_MOHs",
31471 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31472 "version": "0.0.0",
31473 "filename": "server/api/voiceMusicOnHold/index.js",
31474 "groupTitle": "Voice_MOHs"
31478 "url": "/api/voice/mohs/{id}",
31479 "title": "Update an existing Music On Hold",
31482 "title": "Example usage:",
31483 "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",
31487 "name": "updateMusic_On_Holds",
31488 "group": "Voice_MOHs",
31489 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31490 "version": "0.0.0",
31491 "filename": "server/api/voiceMusicOnHold/index.js",
31492 "groupTitle": "Voice_MOHs"
31496 "url": "/api/voice/mails",
31497 "title": "Creates a new Mail",
31500 "title": "Example usage:",
31501 "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31505 "name": "CreateMails",
31506 "group": "Voice_Mails",
31514 "field": "customer_id",
31521 "field": "context",
31528 "field": "mailbox",
31535 "field": "password",
31542 "field": "fullname",
31592 "field": "dialout",
31599 "field": "callback",
31621 "field": "operator",
31632 "field": "envelope",
31643 "field": "sayduration",
31650 "field": "saydurationm",
31661 "field": "sendvoicemail",
31683 "field": "nextaftercmd",
31694 "field": "forcename",
31705 "field": "forcegreetings",
31716 "field": "hidefromdir",
31730 "field": "emailsubject",
31737 "field": "emailbody",
31744 "field": "maxsecs",
31764 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31765 "version": "0.0.0",
31766 "filename": "server/api/voiceMail/index.js",
31767 "groupTitle": "Voice_Mails"
31771 "url": "/api/voice/mails/{id}",
31772 "title": "Deletes a Mail",
31775 "title": "Example usage:",
31776 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31780 "name": "DeleteMails",
31781 "group": "Voice_Mails",
31782 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31783 "version": "0.0.0",
31784 "filename": "server/api/voiceMail/index.js",
31785 "groupTitle": "Voice_Mails"
31789 "url": "/api/voice/mails",
31790 "title": "Gets a list of Mails",
31793 "title": "Example usage:",
31794 "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31798 "name": "GetMails",
31799 "group": "Voice_Mails",
31800 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31801 "version": "0.0.0",
31802 "filename": "server/api/voiceMail/index.js",
31803 "groupTitle": "Voice_Mails"
31807 "url": "/api/voice/mails/{id}",
31808 "title": "Gets a single Mail",
31811 "title": "Example usage:",
31812 "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31816 "name": "ShowMails",
31817 "group": "Voice_Mails",
31818 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31819 "version": "0.0.0",
31820 "filename": "server/api/voiceMail/index.js",
31821 "groupTitle": "Voice_Mails"
31825 "url": "/api/voice/mails/{id}/messages",
31826 "title": "Gets voice mail messages",
31829 "title": "Example usage:",
31830 "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31834 "name": "getMessages",
31835 "group": "Voice_Mails",
31836 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31837 "version": "0.0.0",
31838 "filename": "server/api/voiceMail/index.js",
31839 "groupTitle": "Voice_Mails"
31843 "url": "/api/voice/mails/{id}",
31844 "title": "Update an existing Mail",
31847 "title": "Example usage:",
31848 "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",
31852 "name": "updateMails",
31853 "group": "Voice_Mails",
31854 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31855 "version": "0.0.0",
31856 "filename": "server/api/voiceMail/index.js",
31857 "groupTitle": "Voice_Mails"
31861 "url": "/api/voice/mails/messages",
31862 "title": "Creates a new Message",
31865 "title": "Example usage:",
31866 "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",
31870 "name": "CreateMessages",
31871 "group": "Voice_Messages",
31900 "field": "context",
31907 "field": "macrocontext",
31914 "field": "callerid",
31921 "field": "origtime",
31928 "field": "duration",
31935 "field": "mailboxuser",
31942 "field": "mailboxcontext",
31949 "field": "recording",
31976 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31977 "version": "0.0.0",
31978 "filename": "server/api/voiceMailMessage/index.js",
31979 "groupTitle": "Voice_Messages"
31983 "url": "/api/voice/mails/messages/{id}",
31984 "title": "Deletes a Message",
31987 "title": "Example usage:",
31988 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31992 "name": "DeleteMessages",
31993 "group": "Voice_Messages",
31994 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31995 "version": "0.0.0",
31996 "filename": "server/api/voiceMailMessage/index.js",
31997 "groupTitle": "Voice_Messages"
32001 "url": "/api/voice/mails/messages",
32002 "title": "Gets a list of Messages",
32005 "title": "Example usage:",
32006 "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
32010 "name": "GetMessages",
32011 "group": "Voice_Messages",
32012 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32013 "version": "0.0.0",
32014 "filename": "server/api/voiceMailMessage/index.js",
32015 "groupTitle": "Voice_Messages"
32019 "url": "/api/voice/mails/messages/{id}",
32020 "title": "Gets a single Message",
32023 "title": "Example usage:",
32024 "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
32028 "name": "ShowMessages",
32029 "group": "Voice_Messages",
32030 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32031 "version": "0.0.0",
32032 "filename": "server/api/voiceMailMessage/index.js",
32033 "groupTitle": "Voice_Messages"
32037 "url": "voice/mails/messages/{id}/download",
32038 "title": "Download Voice Message",
32041 "title": "Example usage:",
32042 "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
32046 "name": "download",
32047 "group": "Voice_Messages",
32048 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32049 "version": "0.0.0",
32050 "filename": "server/api/voiceMailMessage/index.js",
32051 "groupTitle": "Voice_Messages"
32055 "url": "/api/voice/mails/messages/{id}",
32056 "title": "Update an existing Message",
32059 "title": "Example usage:",
32060 "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",
32064 "name": "updateMessages",
32065 "group": "Voice_Messages",
32066 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32067 "version": "0.0.0",
32068 "filename": "server/api/voiceMailMessage/index.js",
32069 "groupTitle": "Voice_Messages"
32073 "url": "/api/voice/prefixes/{id}/teams",
32074 "title": "Add teams to voice prefix",
32077 "title": "Example usage:",
32078 "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",
32082 "name": "AddTeams",
32083 "group": "Voice_Prefix",
32084 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32085 "version": "0.0.0",
32086 "filename": "server/api/voicePrefix/index.js",
32087 "groupTitle": "Voice_Prefix"
32091 "url": "/api/voice/prefixes/{id}/teams",
32092 "title": "Gets voice prefix team",
32095 "title": "Example usage:",
32096 "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X GET",
32100 "name": "GetTeams",
32101 "group": "Voice_Prefix",
32102 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32103 "version": "0.0.0",
32104 "filename": "server/api/voicePrefix/index.js",
32105 "groupTitle": "Voice_Prefix"
32109 "url": "/api/voice/prefixes/{id}/users",
32110 "title": "Add agents to a prefix",
32113 "title": "Example usage:",
32114 "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",
32118 "name": "AddAgents",
32119 "group": "Voice_Prefixes",
32120 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32121 "version": "0.0.0",
32122 "filename": "server/api/voicePrefix/index.js",
32123 "groupTitle": "Voice_Prefixes"
32127 "url": "/api/voice/prefixes/{id}",
32128 "title": "Deletes a Prefix",
32131 "title": "Example usage:",
32132 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
32136 "name": "DeletePrefixes",
32137 "group": "Voice_Prefixes",
32138 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32139 "version": "0.0.0",
32140 "filename": "server/api/voicePrefix/index.js",
32141 "groupTitle": "Voice_Prefixes"
32145 "url": "/api/voice/prefixes/describe",
32146 "title": "Gets table info about Prefixes",
32149 "title": "Example usage:",
32150 "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
32154 "name": "DescribePrefixes",
32155 "group": "Voice_Prefixes",
32156 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32157 "version": "0.0.0",
32158 "filename": "server/api/voicePrefix/index.js",
32159 "groupTitle": "Voice_Prefixes"
32163 "url": "/api/voice/prefixes/{id}/users",
32164 "title": "Gets agents from prefix",
32167 "title": "Example usage:",
32168 "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
32172 "name": "GetAgents",
32173 "group": "Voice_Prefixes",
32174 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32175 "version": "0.0.0",
32176 "filename": "server/api/voicePrefix/index.js",
32177 "groupTitle": "Voice_Prefixes"
32181 "url": "/api/voice/prefixes",
32182 "title": "Gets a list of Prefixes",
32185 "title": "Example usage:",
32186 "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
32190 "name": "GetPrefixes",
32191 "group": "Voice_Prefixes",
32192 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32193 "version": "0.0.0",
32194 "filename": "server/api/voicePrefix/index.js",
32195 "groupTitle": "Voice_Prefixes"
32199 "url": "/api/voice/prefixes/{id}/users",
32200 "title": "Removes agents from a prefix",
32203 "title": "Example usage:",
32204 "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32208 "name": "RemoveAgents",
32209 "group": "Voice_Prefixes",
32210 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32211 "version": "0.0.0",
32212 "filename": "server/api/voicePrefix/index.js",
32213 "groupTitle": "Voice_Prefixes"
32217 "url": "/api/voice/prefixes/{id}",
32218 "title": "Gets a single Prefix",
32221 "title": "Example usage:",
32222 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
32226 "name": "ShowPrefixes",
32227 "group": "Voice_Prefixes",
32228 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32229 "version": "0.0.0",
32230 "filename": "server/api/voicePrefix/index.js",
32231 "groupTitle": "Voice_Prefixes"
32235 "url": "/api/voice/prefixes/{id}",
32236 "title": "Update an existing prefix",
32239 "title": "Example usage:",
32240 "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
32245 "group": "Voice_Prefixes",
32246 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32247 "version": "0.0.0",
32248 "filename": "server/api/voicePrefix/index.js",
32249 "groupTitle": "Voice_Prefixes"
32253 "url": "/api/voice/prefixes",
32254 "title": "Create a prefix",
32257 "title": "Example usage:",
32258 "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
32263 "group": "Voice_Prefixes",
32264 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32265 "version": "0.0.0",
32266 "filename": "server/api/voicePrefix/index.js",
32267 "groupTitle": "Voice_Prefixes"
32271 "url": "/api/voice/queues/reports/describe",
32272 "title": "Gets table info about Queue Reports",
32275 "title": "Example usage:",
32276 "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
32280 "name": "DescribeQueue_Reports",
32281 "group": "Voice_Queue_Reports",
32282 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32283 "version": "0.0.0",
32284 "filename": "server/api/voiceQueueReport/index.js",
32285 "groupTitle": "Voice_Queue_Reports"
32289 "url": "/api/voice/queues/reports",
32290 "title": "Gets a list of Queue Reports",
32293 "title": "Example usage:",
32294 "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
32298 "name": "GetQueue_Reports",
32299 "group": "Voice_Queue_Reports",
32300 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32301 "version": "0.0.0",
32302 "filename": "server/api/voiceQueueReport/index.js",
32303 "groupTitle": "Voice_Queue_Reports"
32307 "url": "/api/voice/queues/reports/{id}",
32308 "title": "Gets a single Queue Report",
32311 "title": "Example usage:",
32312 "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
32316 "name": "ShowQueue_Reports",
32317 "group": "Voice_Queue_Reports",
32318 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32319 "version": "0.0.0",
32320 "filename": "server/api/voiceQueueReport/index.js",
32321 "groupTitle": "Voice_Queue_Reports"
32325 "url": "/api/voice/queues/reports/index",
32326 "title": "Get Voice Queues Report",
32329 "title": "Example usage:",
32330 "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
32334 "name": "getVoiceQueuesReport",
32335 "group": "Voice_Queue_Reports",
32336 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32337 "version": "0.0.0",
32338 "filename": "server/api/voiceQueueReport/index.js",
32339 "groupTitle": "Voice_Queue_Reports"
32343 "url": "/api/voice/queues/{id}/users",
32344 "title": "Add agents to queue",
32347 "title": "Example usage:",
32348 "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",
32352 "name": "AddAgents",
32353 "group": "Voice_Queues",
32354 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32355 "version": "0.0.0",
32356 "filename": "server/api/voiceQueue/index.js",
32357 "groupTitle": "Voice_Queues"
32361 "url": "/api/voice/queues/{id}/blacklists",
32362 "title": "Add blacklists to a queue",
32365 "title": "Example usage:",
32366 "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",
32370 "name": "AddBlackLists",
32371 "group": "Voice_Queues",
32372 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32373 "version": "0.0.0",
32374 "filename": "server/api/voiceQueue/index.js",
32375 "groupTitle": "Voice_Queues"
32379 "url": "/api/voice/queues/{id}/lists",
32380 "title": "Add lists to a queue",
32383 "title": "Example usage:",
32384 "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",
32388 "name": "AddLists",
32389 "group": "Voice_Queues",
32390 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32391 "version": "0.0.0",
32392 "filename": "server/api/voiceQueue/index.js",
32393 "groupTitle": "Voice_Queues"
32397 "url": "/api/voice/queues/{id}/teams",
32398 "title": "Add teams to queue",
32401 "title": "Example usage:",
32402 "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",
32406 "name": "AddTeams",
32407 "group": "Voice_Queues",
32408 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32409 "version": "0.0.0",
32410 "filename": "server/api/voiceQueue/index.js",
32411 "groupTitle": "Voice_Queues"
32415 "url": "/api/voice/queues/clone",
32416 "title": "Clone an existing Queue",
32419 "title": "Example usage:",
32420 "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",
32424 "name": "CloneQueues",
32425 "group": "Voice_Queues",
32426 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32427 "version": "0.0.0",
32428 "filename": "server/api/voiceQueue/index.js",
32429 "groupTitle": "Voice_Queues"
32433 "url": "/api/voice/queues",
32434 "title": "Creates a new Queue",
32437 "title": "Example usage:",
32438 "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32442 "name": "CreateQueues",
32443 "group": "Voice_Queues",
32469 "field": "musiconhold",
32476 "field": "announce",
32494 "field": "strategy",
32501 "field": "servicelevel",
32508 "field": "context",
32515 "field": "penaltymemberslimit",
32522 "field": "timeout",
32536 "field": "timeoutpriority",
32550 "field": "wrapuptime",
32561 "field": "autofill",
32573 "field": "autopause",
32580 "field": "autopausedelay",
32591 "field": "autopausebusy",
32602 "field": "autopauseunavail",
32620 "field": "setinterfacevar",
32631 "field": "setqueueentryvar",
32642 "field": "setqueuevar",
32653 "field": "eventmemberstatus",
32660 "field": "membermacro",
32667 "field": "membergosub",
32674 "field": "announce_frequency",
32681 "field": "min_announce_frequency",
32688 "field": "periodic_announce_frequency",
32699 "field": "random_periodic_announce",
32710 "field": "relative_periodic_announce",
32722 "field": "announce_holdtime",
32729 "field": "announce_position",
32740 "field": "announce_to_first_user",
32747 "field": "announce_position_limit",
32762 "field": "announce_round_seconds",
32769 "field": "monitor_format",
32776 "field": "monitor_type",
32783 "field": "queue_youarenext",
32790 "field": "queue_thereare",
32797 "field": "queue_callswaiting",
32804 "field": "queue_holdtime",
32811 "field": "queue_minute",
32818 "field": "queue_minutes",
32825 "field": "queue_seconds",
32832 "field": "queue_thankyou",
32839 "field": "queue_reporthold",
32846 "field": "queue_quantity1",
32853 "field": "queue_quantity2",
32860 "field": "queue_periodic_announce",
32867 "field": "queue_less_than",
32874 "field": "periodic_announce",
32881 "field": "joinempty",
32888 "field": "leavewhenempty",
32899 "field": "reportholdtime",
32910 "field": "ringinuse",
32917 "field": "memberdelay",
32928 "field": "timeoutrestart",
32935 "field": "defaultrule",
32942 "field": "description",
32956 "field": "acwTimeout",
32963 "field": "dialActive",
32964 "description": "<p>Active/Disactive Campaign</p>"
32977 "field": "dialMethod",
32978 "description": "<p>Dial Method.</p>"
32984 "field": "dialLimitChannel",
32985 "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32991 "field": "dialLimitQueue",
32992 "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32998 "field": "dialPowerLevel",
32999 "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
33005 "\"agentBusyFactor\"",
33009 "field": "dialPredictiveOptimization",
33010 "description": "<p>Only for predictive method.</p>"
33016 "field": "dialPredictiveOptimizationPercentage",
33017 "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
33023 "field": "dialPredictiveInterval",
33024 "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
33030 "field": "dialOriginateCallerIdName",
33037 "field": "dialOriginateCallerIdNumber",
33044 "field": "dialOriginateTimeout",
33045 "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
33051 "field": "dialQueueOptions",
33052 "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
33058 "field": "dialQueueTimeout",
33059 "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
33065 "field": "dialQueueProject",
33066 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
33072 "field": "dialCongestionMaxRetry",
33073 "description": "<p>#Congestion Retry (min:1, max:999)</p>"
33079 "field": "dialCongestionRetryFrequency",
33080 "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
33086 "field": "dialBusyMaxRetry",
33087 "description": "<p>#Busy Retry (min:1, max:999)</p>"
33093 "field": "dialBusyRetryFrequency",
33094 "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
33100 "field": "dialNoAnswerMaxRetry",
33101 "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
33107 "field": "dialNoAnswerRetryFrequency",
33108 "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
33114 "field": "dialGlobalMaxRetry",
33115 "description": "<p>#Global Max Retry (min:1, max:999)</p>"
33121 "field": "dialTimezone",
33128 "field": "dialGlobalInterval",
33135 "field": "dialPrefix",
33147 "field": "dialCheckDuplicateType",
33154 "field": "dialAMDActive",
33155 "description": "<p>Active/Disactive AMD</p>"
33161 "field": "dialAMDInitialSilence",
33162 "description": "<p>#AMD Initial Silence</p>"
33168 "field": "dialAMDGreeting",
33169 "description": "<p>#AMD Greeting</p>"
33175 "field": "dialAMDAfterGreetingSilence",
33176 "description": "<p>#AMD After Greeting Silence</p>"
33182 "field": "dialAMDTotalAnalysisTime",
33183 "description": "<p>#AMD Total Analysis Time</p>"
33189 "field": "dialAMDMinWordLength",
33190 "description": "<p>#AMD Min Word Length</p>"
33196 "field": "dialAMDBetweenWordsSilence",
33197 "description": "<p>#AMD Between Words Silence</p>"
33203 "field": "dialAMDMaximumNumberOfWords",
33204 "description": "<p>#AMD Maximum Number Of Words</p>"
33210 "field": "dialAMDSilenceThreshold",
33211 "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
33217 "field": "dialAMDMaximumWordLength",
33218 "description": "<p>#AMD Maximum Word Length</p>"
33224 "field": "dialRecallMeTimeout",
33225 "description": "<p>#RecallMe Timeout (min:1)</p>"
33231 "field": "dialRecallInQueue",
33232 "description": "<p>Active/Disactive Recall In Queue</p>"
33242 "field": "dialOrderByScheduledAt",
33249 "field": "dialQueueProject2",
33250 "description": "<p>AGI queue option (use: agi://127.0.0.1/square,<project_name>)</p>"
33256 "field": "dialAgiAfterHangupClient",
33263 "field": "dialAgiAfterHangupAgent",
33270 "field": "dialRandomLastDigitCallerIdNumber",
33271 "description": "<p>Random Last Digit (min:1, max:15)</p>"
33277 "field": "dialCutDigit",
33278 "description": "<p>Cut Digit (min:1, max:15)</p>"
33284 "field": "dialNoSuchNumberMaxRetry",
33285 "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
33291 "field": "dialNoSuchNumberRetryFrequency",
33292 "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
33298 "field": "dialDropMaxRetry",
33299 "description": "<p>#Drop Retry (min:1, max:999)</p>"
33305 "field": "dialDropRetryFrequency",
33306 "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
33312 "field": "dialAbandonedMaxRetry",
33313 "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
33319 "field": "dialAbandonedRetryFrequency",
33320 "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
33326 "field": "dialMachineMaxRetry",
33327 "description": "<p>#Machine Retry (min:1, max:999)</p>"
33333 "field": "dialMachineRetryFrequency",
33334 "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
33340 "field": "dialAgentRejectMaxRetry",
33341 "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
33347 "field": "dialAgentRejectRetryFrequency",
33348 "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
33354 "field": "mandatoryDispositionPauseId",
33355 "description": "<p>Status to put when mandatory disposition is enabled</p>"
33361 "field": "mandatoryDisposition",
33362 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
33368 "field": "dialPredictiveIntervalMaxThreshold",
33375 "field": "dialPredictiveIntervalMinThreshold",
33382 "field": "dialPreviewAutoRecallMe",
33388 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33389 "version": "0.0.0",
33390 "filename": "server/api/voiceQueue/index.js",
33391 "groupTitle": "Voice_Queues"
33395 "url": "/api/voice/queues/{id}",
33396 "title": "Deletes a Queue",
33399 "title": "Example usage:",
33400 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
33404 "name": "DeleteQueues",
33405 "group": "Voice_Queues",
33406 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33407 "version": "0.0.0",
33408 "filename": "server/api/voiceQueue/index.js",
33409 "groupTitle": "Voice_Queues"
33413 "url": "/api/voice/queues/{id}/users",
33414 "title": "Gets queue agents",
33417 "title": "Example usage:",
33418 "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
33422 "name": "GetAgents",
33423 "group": "Voice_Queues",
33424 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33425 "version": "0.0.0",
33426 "filename": "server/api/voiceQueue/index.js",
33427 "groupTitle": "Voice_Queues"
33431 "url": "/api/voice/queues/{id}/blacklists",
33432 "title": "Get queue blacklists",
33435 "title": "Example usage:",
33436 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
33440 "name": "GetBlackLists",
33441 "group": "Voice_Queues",
33442 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33443 "version": "0.0.0",
33444 "filename": "server/api/voiceQueue/index.js",
33445 "groupTitle": "Voice_Queues"
33449 "url": "/api/voice/queues/{id}/finals",
33450 "title": "Gets queue hopper finals",
33453 "title": "Example usage:",
33454 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password} -X GET",
33458 "name": "GetHopperFinals",
33459 "group": "Voice_Queues",
33460 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33461 "version": "0.0.0",
33462 "filename": "server/api/voiceQueue/index.js",
33463 "groupTitle": "Voice_Queues"
33467 "url": "/api/voice/queues/{id}/hopper_histories",
33468 "title": "Gets queue hopper histories",
33471 "title": "Example usage:",
33472 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
33476 "name": "GetHopperHistories",
33477 "group": "Voice_Queues",
33478 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33479 "version": "0.0.0",
33480 "filename": "server/api/voiceQueue/index.js",
33481 "groupTitle": "Voice_Queues"
33485 "url": "/api/voice/queues/{id}/hoppers",
33486 "title": "Gets queue hoppers",
33489 "title": "Example usage:",
33490 "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
33494 "name": "GetHoppers",
33495 "group": "Voice_Queues",
33496 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33497 "version": "0.0.0",
33498 "filename": "server/api/voiceQueue/index.js",
33499 "groupTitle": "Voice_Queues"
33503 "url": "/api/voice/queues/{id}/lists",
33504 "title": "Get queue lists",
33507 "title": "Example usage:",
33508 "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
33512 "name": "GetLists",
33513 "group": "Voice_Queues",
33514 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33515 "version": "0.0.0",
33516 "filename": "server/api/voiceQueue/index.js",
33517 "groupTitle": "Voice_Queues"
33521 "url": "/api/voice/queues/{id}/members",
33522 "title": "Gets queue members",
33525 "title": "Example usage:",
33526 "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
33530 "name": "GetMembers",
33531 "group": "Voice_Queues",
33532 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33533 "version": "0.0.0",
33534 "filename": "server/api/voiceQueue/index.js",
33535 "groupTitle": "Voice_Queues"
33539 "url": "/api/voice/queues",
33540 "title": "Gets a list of Queues",
33543 "title": "Example usage:",
33544 "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
33548 "name": "GetQueues",
33549 "group": "Voice_Queues",
33550 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33551 "version": "0.0.0",
33552 "filename": "server/api/voiceQueue/index.js",
33553 "groupTitle": "Voice_Queues"
33557 "url": "/api/voice/queues/{id}/teams",
33558 "title": "Gets queue team",
33561 "title": "Example usage:",
33562 "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X GET",
33566 "name": "GetTeams",
33567 "group": "Voice_Queues",
33568 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33569 "version": "0.0.0",
33570 "filename": "server/api/voiceQueue/index.js",
33571 "groupTitle": "Voice_Queues"
33575 "url": "/api/voice/queues/{id}/users",
33576 "title": "Removes agents from a queue",
33579 "title": "Example usage:",
33580 "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33584 "name": "RemoveAgents",
33585 "group": "Voice_Queues",
33586 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33587 "version": "0.0.0",
33588 "filename": "server/api/voiceQueue/index.js",
33589 "groupTitle": "Voice_Queues"
33593 "url": "/api/voice/queues/{id}/blacklists",
33594 "title": "Remove blacklists from a queue",
33597 "title": "Example usage:",
33598 "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33602 "name": "RemoveBlackLists",
33603 "group": "Voice_Queues",
33604 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33605 "version": "0.0.0",
33606 "filename": "server/api/voiceQueue/index.js",
33607 "groupTitle": "Voice_Queues"
33611 "url": "/api/voice/queues/{id}/lists",
33612 "title": "Remove lists from a queue",
33615 "title": "Example usage:",
33616 "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33620 "name": "RemoveLists",
33621 "group": "Voice_Queues",
33622 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33623 "version": "0.0.0",
33624 "filename": "server/api/voiceQueue/index.js",
33625 "groupTitle": "Voice_Queues"
33629 "url": "/api/voice/queues/{id}",
33630 "title": "Gets a single Queue",
33633 "title": "Example usage:",
33634 "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
33638 "name": "ShowQueues",
33639 "group": "Voice_Queues",
33640 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33641 "version": "0.0.0",
33642 "filename": "server/api/voiceQueue/index.js",
33643 "groupTitle": "Voice_Queues"
33647 "url": "/api/voice/queues/{id}/blacks",
33648 "title": "Gets queue hopper blacks",
33651 "title": "Example usage:",
33652 "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password} -X GET",
33656 "name": "getHopperBlacks",
33657 "group": "Voice_Queues",
33658 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33659 "version": "0.0.0",
33660 "filename": "server/api/voiceQueue/index.js",
33661 "groupTitle": "Voice_Queues"
33665 "url": "/api/voice/queues/{id}",
33666 "title": "Update an existing Queue",
33669 "title": "Example usage:",
33670 "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",
33674 "name": "updateQueues",
33675 "group": "Voice_Queues",
33676 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33677 "version": "0.0.0",
33678 "filename": "server/api/voiceQueue/index.js",
33679 "groupTitle": "Voice_Queues"
33683 "url": "/api/voice/recordings",
33684 "title": "Creates a new Recording",
33687 "title": "Example usage:",
33688 "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33692 "name": "CreateRecordings",
33693 "group": "Voice_Recordings",
33708 "field": "uniqueid",
33715 "field": "channel",
33722 "field": "membername",
33729 "field": "calleridnum",
33736 "field": "calleridname",
33743 "field": "connectedlinenum",
33750 "field": "connectedlinename",
33757 "field": "accountcode",
33764 "field": "context",
33806 "field": "userDisposition",
33813 "field": "userSecondDisposition",
33820 "field": "userThirdDisposition",
33827 "field": "location",
33834 "field": "transcribeName",
33841 "field": "transcribeStatus",
33848 "field": "fileUri",
33855 "field": "fileText",
33862 "field": "failureReason",
33869 "field": "sentiment",
33876 "field": "sPositive",
33883 "field": "sNegative",
33890 "field": "sNeutral",
33904 "field": "tempSentiment",
33911 "field": "createdAt",
33918 "field": "updatedAt",
33924 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33925 "version": "0.0.0",
33926 "filename": "server/api/voiceRecording/index.js",
33927 "groupTitle": "Voice_Recordings"
33931 "url": "/api/voice/recordings/describe",
33932 "title": "Gets table info about Recordings",
33935 "title": "Example usage:",
33936 "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33940 "name": "DescribeRecordings",
33941 "group": "Voice_Recordings",
33942 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33943 "version": "0.0.0",
33944 "filename": "server/api/voiceRecording/index.js",
33945 "groupTitle": "Voice_Recordings"
33949 "url": "/api/voice/recordings",
33950 "title": "Gets a list of Recordings",
33953 "title": "Example usage:",
33954 "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33958 "name": "GetRecordings",
33959 "group": "Voice_Recordings",
33960 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33961 "version": "0.0.0",
33962 "filename": "server/api/voiceRecording/index.js",
33963 "groupTitle": "Voice_Recordings"
33967 "url": "/api/voice/recordings/{id}",
33968 "title": "Gets a single Recording",
33971 "title": "Example usage:",
33972 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33976 "name": "ShowRecordings",
33977 "group": "Voice_Recordings",
33978 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33979 "version": "0.0.0",
33980 "filename": "server/api/voiceRecording/index.js",
33981 "groupTitle": "Voice_Recordings"
33985 "url": "/api/voice/recordings/{id}",
33986 "title": "Delete voice recording",
33989 "title": "Example usage:",
33990 "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33995 "group": "Voice_Recordings",
33996 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33997 "version": "0.0.0",
33998 "filename": "server/api/voiceRecording/index.js",
33999 "groupTitle": "Voice_Recordings"
34003 "url": "/api/voice/recordings/{id}/download",
34004 "title": "Download Recording",
34007 "title": "Example usage:",
34008 "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
34012 "name": "download",
34013 "group": "Voice_Recordings",
34014 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34015 "version": "0.0.0",
34016 "filename": "server/api/voiceRecording/index.js",
34017 "groupTitle": "Voice_Recordings"
34021 "url": "/api/voice/recordings/{id}/downloads",
34022 "title": "Download Recording",
34025 "title": "Example usage:",
34026 "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
34030 "name": "downloads",
34031 "group": "Voice_Recordings",
34032 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34033 "version": "0.0.0",
34034 "filename": "server/api/voiceRecording/index.js",
34035 "groupTitle": "Voice_Recordings"
34039 "url": "/api/voice/recordings/{id}/transcribe",
34040 "title": "Run Transcribe Recording",
34043 "title": "Example usage:",
34044 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
34048 "name": "transcribe",
34049 "group": "Voice_Recordings",
34050 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34051 "version": "0.0.0",
34052 "filename": "server/api/voiceRecording/index.js",
34053 "groupTitle": "Voice_Recordings"
34057 "url": "/api/voice/recordings/{id}/transcribe",
34058 "title": "Run Transcribe Recording",
34061 "title": "Example usage:",
34062 "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
34066 "name": "transcribe",
34067 "group": "Voice_Recordings",
34068 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34069 "version": "0.0.0",
34070 "filename": "server/api/voiceRecording/index.js",
34071 "groupTitle": "Voice_Recordings"
34075 "url": "/api/voice/recordings/{id}",
34076 "title": "Update an existing Recording",
34079 "title": "Example usage:",
34080 "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",
34084 "name": "updateRecordings",
34085 "group": "Voice_Recordings",
34086 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34087 "version": "0.0.0",
34088 "filename": "server/api/voiceRecording/index.js",
34089 "groupTitle": "Voice_Recordings"
34093 "url": "/api/voice/transfers/reports",
34094 "title": "Creates a new Transfer Report",
34097 "title": "Example usage:",
34098 "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",
34102 "name": "CreateTransfer_Reports",
34103 "group": "Voice_Transfer_Reports",
34129 "field": "transfererchannel",
34136 "field": "transferercalleridnum",
34143 "field": "transferercalleridname",
34150 "field": "transfererconnectedlinenum",
34157 "field": "transfererconnectedlinename",
34164 "field": "transfereraccountcode",
34171 "field": "transferercontext",
34178 "field": "transfererexten",
34185 "field": "transfererlinkedid",
34192 "field": "transfereechannel",
34199 "field": "transfereecalleridnum",
34206 "field": "transfereecalleridname",
34213 "field": "transfereeconnectedlinenum",
34220 "field": "transfereeconnectedlinename",
34227 "field": "transfereeaccountcode",
34234 "field": "transfereecontext",
34241 "field": "transfereeexten",
34248 "field": "transfereelinkedid",
34259 "field": "isexternal",
34266 "field": "context",
34273 "field": "extension",
34279 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34280 "version": "0.0.0",
34281 "filename": "server/api/voiceTransferReport/index.js",
34282 "groupTitle": "Voice_Transfer_Reports"
34286 "url": "/api/voice/transfers/reports/{id}",
34287 "title": "Deletes a Transfer Report",
34290 "title": "Example usage:",
34291 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
34295 "name": "DeleteTransfer_Reports",
34296 "group": "Voice_Transfer_Reports",
34297 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34298 "version": "0.0.0",
34299 "filename": "server/api/voiceTransferReport/index.js",
34300 "groupTitle": "Voice_Transfer_Reports"
34304 "url": "/api/voice/transfers/reports/describe",
34305 "title": "Gets table info about Transfer Reports",
34308 "title": "Example usage:",
34309 "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
34313 "name": "DescribeTransfer_Reports",
34314 "group": "Voice_Transfer_Reports",
34315 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34316 "version": "0.0.0",
34317 "filename": "server/api/voiceTransferReport/index.js",
34318 "groupTitle": "Voice_Transfer_Reports"
34322 "url": "/api/voice/transfers/reports",
34323 "title": "Gets a list of Transfer Reports",
34326 "title": "Example usage:",
34327 "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
34331 "name": "GetTransfer_Reports",
34332 "group": "Voice_Transfer_Reports",
34333 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34334 "version": "0.0.0",
34335 "filename": "server/api/voiceTransferReport/index.js",
34336 "groupTitle": "Voice_Transfer_Reports"
34340 "url": "/api/voice/transfers/reports/{id}",
34341 "title": "Gets a single Transfer Report",
34344 "title": "Example usage:",
34345 "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
34349 "name": "ShowTransfer_Reports",
34350 "group": "Voice_Transfer_Reports",
34351 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34352 "version": "0.0.0",
34353 "filename": "server/api/voiceTransferReport/index.js",
34354 "groupTitle": "Voice_Transfer_Reports"
34358 "url": "/api/voice/transfers/reports/{id}",
34359 "title": "Update an existing Transfer Report",
34362 "title": "Example usage:",
34363 "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",
34367 "name": "updateTransfer_Reports",
34368 "group": "Voice_Transfer_Reports",
34369 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34370 "version": "0.0.0",
34371 "filename": "server/api/voiceTransferReport/index.js",
34372 "groupTitle": "Voice_Transfer_Reports"
34376 "url": "/api/integrations/vtiger/accounts",
34377 "title": "Creates a new Vtiger Account",
34380 "title": "Example usage:",
34381 "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",
34385 "name": "CreateVtiger_Accounts",
34386 "group": "Vtiger_Accounts",
34401 "field": "description",
34408 "field": "username",
34415 "field": "moduleName",
34422 "field": "remoteUri",
34429 "field": "serverUrl",
34436 "field": "accessKey",
34442 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34443 "version": "0.0.0",
34444 "filename": "server/api/intVtigerAccount/index.js",
34445 "groupTitle": "Vtiger_Accounts"
34449 "url": "/api/integrations/vtiger/accounts/{id}",
34450 "title": "Deletes a Vtiger Account",
34453 "title": "Example usage:",
34454 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
34458 "name": "DeleteVtiger_Accounts",
34459 "group": "Vtiger_Accounts",
34460 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34461 "version": "0.0.0",
34462 "filename": "server/api/intVtigerAccount/index.js",
34463 "groupTitle": "Vtiger_Accounts"
34467 "url": "/api/integrations/vtiger/accounts",
34468 "title": "Gets a list of Vtiger Accounts",
34471 "title": "Example usage:",
34472 "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
34476 "name": "GetVtiger_Accounts",
34477 "group": "Vtiger_Accounts",
34478 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34479 "version": "0.0.0",
34480 "filename": "server/api/intVtigerAccount/index.js",
34481 "groupTitle": "Vtiger_Accounts"
34485 "url": "/api/integrations/vtiger/accounts/{id}",
34486 "title": "Gets a single Vtiger Account",
34489 "title": "Example usage:",
34490 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
34494 "name": "ShowVtiger_Accounts",
34495 "group": "Vtiger_Accounts",
34496 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34497 "version": "0.0.0",
34498 "filename": "server/api/intVtigerAccount/index.js",
34499 "groupTitle": "Vtiger_Accounts"
34503 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34504 "title": "Creates new configuration",
34507 "title": "Example usage:",
34508 "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",
34512 "name": "addConfiguration",
34513 "group": "Vtiger_Accounts",
34514 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34515 "version": "0.0.0",
34516 "filename": "server/api/intVtigerAccount/index.js",
34517 "groupTitle": "Vtiger_Accounts"
34521 "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34522 "title": "Gets account configurations",
34525 "title": "Example usage:",
34526 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
34530 "name": "getConfigurations",
34531 "group": "Vtiger_Accounts",
34532 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34533 "version": "0.0.0",
34534 "filename": "server/api/intVtigerAccount/index.js",
34535 "groupTitle": "Vtiger_Accounts"
34539 "url": "/api/integrations/vtiger/accounts/{id}/fields",
34540 "title": "Gets account fields",
34543 "title": "Example usage:",
34544 "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
34548 "name": "getFields",
34549 "group": "Vtiger_Accounts",
34550 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34551 "version": "0.0.0",
34552 "filename": "server/api/intVtigerAccount/index.js",
34553 "groupTitle": "Vtiger_Accounts"
34557 "url": "/api/integrations/vtiger/accounts/{id}",
34558 "title": "Update an existing Vtiger Account",
34561 "title": "Example usage:",
34562 "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",
34566 "name": "updateVtiger_Accounts",
34567 "group": "Vtiger_Accounts",
34568 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34569 "version": "0.0.0",
34570 "filename": "server/api/intVtigerAccount/index.js",
34571 "groupTitle": "Vtiger_Accounts"
34575 "url": "/api/integrations/vtiger/configurations",
34576 "title": "Creates a new Vtiger Configuration",
34579 "title": "Example usage:",
34580 "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",
34584 "name": "CreateVtiger_Configurations",
34585 "group": "Vtiger_Configurations",
34600 "field": "description",
34606 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34607 "version": "0.0.0",
34608 "filename": "server/api/intVtigerConfiguration/index.js",
34609 "groupTitle": "Vtiger_Configurations"
34613 "url": "/api/integrations/vtiger/configurations/{id}",
34614 "title": "Deletes a Vtiger Configuration",
34617 "title": "Example usage:",
34618 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
34622 "name": "DeleteVtiger_Configurations",
34623 "group": "Vtiger_Configurations",
34624 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34625 "version": "0.0.0",
34626 "filename": "server/api/intVtigerConfiguration/index.js",
34627 "groupTitle": "Vtiger_Configurations"
34631 "url": "/api/integrations/vtiger/configurations",
34632 "title": "Gets a list of Vtiger Configurations",
34635 "title": "Example usage:",
34636 "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
34640 "name": "GetVtiger_Configurations",
34641 "group": "Vtiger_Configurations",
34642 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34643 "version": "0.0.0",
34644 "filename": "server/api/intVtigerConfiguration/index.js",
34645 "groupTitle": "Vtiger_Configurations"
34649 "url": "/api/integrations/vtiger/configurations/{id}",
34650 "title": "Gets a single Vtiger Configuration",
34653 "title": "Example usage:",
34654 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
34658 "name": "ShowVtiger_Configurations",
34659 "group": "Vtiger_Configurations",
34660 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34661 "version": "0.0.0",
34662 "filename": "server/api/intVtigerConfiguration/index.js",
34663 "groupTitle": "Vtiger_Configurations"
34667 "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
34668 "title": "Gets configurations descriptions",
34671 "title": "Example usage:",
34672 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
34676 "name": "getDescriptions",
34677 "group": "Vtiger_Configurations",
34678 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34679 "version": "0.0.0",
34680 "filename": "server/api/intVtigerConfiguration/index.js",
34681 "groupTitle": "Vtiger_Configurations"
34685 "url": "/api/integrations/vtiger/configurations/{id}/fields",
34686 "title": "Gets configurations fields",
34689 "title": "Example usage:",
34690 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
34694 "name": "getFields",
34695 "group": "Vtiger_Configurations",
34696 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34697 "version": "0.0.0",
34698 "filename": "server/api/intVtigerConfiguration/index.js",
34699 "groupTitle": "Vtiger_Configurations"
34703 "url": "/api/integrations/vtiger/configurations/{id}/subjects",
34704 "title": "Gets configurations subjects",
34707 "title": "Example usage:",
34708 "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
34712 "name": "getSubjects",
34713 "group": "Vtiger_Configurations",
34714 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34715 "version": "0.0.0",
34716 "filename": "server/api/intVtigerConfiguration/index.js",
34717 "groupTitle": "Vtiger_Configurations"
34721 "url": "/api/integrations/vtiger/configurations/{id}",
34722 "title": "Update an existing Vtiger Configuration",
34725 "title": "Example usage:",
34726 "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",
34730 "name": "updateVtiger_Configurations",
34731 "group": "Vtiger_Configurations",
34732 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34733 "version": "0.0.0",
34734 "filename": "server/api/intVtigerConfiguration/index.js",
34735 "groupTitle": "Vtiger_Configurations"
34739 "url": "/api/integrations/vtiger/fields",
34740 "title": "Creates a new Vtiger Field",
34743 "title": "Example usage:",
34744 "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",
34748 "name": "CreateVtiger_Fields",
34749 "group": "Vtiger_Fields",
34759 "\"customVariable\"",
34771 "field": "content",
34787 "\"customVariable\""
34790 "field": "keyType",
34797 "field": "keyContent",
34804 "field": "idField",
34811 "field": "nameField",
34818 "field": "customField",
34825 "field": "variableName",
34831 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34832 "version": "0.0.0",
34833 "filename": "server/api/intVtigerField/index.js",
34834 "groupTitle": "Vtiger_Fields"
34838 "url": "/api/integrations/vtiger/fields/{id}",
34839 "title": "Deletes a Vtiger Field",
34842 "title": "Example usage:",
34843 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34847 "name": "DeleteVtiger_Fields",
34848 "group": "Vtiger_Fields",
34849 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34850 "version": "0.0.0",
34851 "filename": "server/api/intVtigerField/index.js",
34852 "groupTitle": "Vtiger_Fields"
34856 "url": "/api/integrations/vtiger/fields",
34857 "title": "Gets a list of Vtiger Fields",
34860 "title": "Example usage:",
34861 "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34865 "name": "GetVtiger_Fields",
34866 "group": "Vtiger_Fields",
34867 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34868 "version": "0.0.0",
34869 "filename": "server/api/intVtigerField/index.js",
34870 "groupTitle": "Vtiger_Fields"
34874 "url": "/api/integrations/vtiger/fields/{id}",
34875 "title": "Gets a single Vtiger Field",
34878 "title": "Example usage:",
34879 "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34883 "name": "ShowVtiger_Fields",
34884 "group": "Vtiger_Fields",
34885 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34886 "version": "0.0.0",
34887 "filename": "server/api/intVtigerField/index.js",
34888 "groupTitle": "Vtiger_Fields"
34892 "url": "/api/integrations/vtiger/fields/{id}",
34893 "title": "Update an existing Vtiger Field",
34896 "title": "Example usage:",
34897 "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",
34901 "name": "updateVtiger_Fields",
34902 "group": "Vtiger_Fields",
34903 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34904 "version": "0.0.0",
34905 "filename": "server/api/intVtigerField/index.js",
34906 "groupTitle": "Vtiger_Fields"
34910 "url": "/api/webbar/answer",
34911 "title": "answer webrtc call",
34914 "title": "Example usage:",
34915 "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34919 "name": "Web_Bar_answer",
34928 "field": "sessionId",
34941 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34942 "version": "0.0.0",
34943 "filename": "server/api/webbar/index.js",
34944 "groupTitle": "WebBar"
34948 "url": "/api/webbar/calls",
34949 "title": "webrtc call list",
34952 "title": "Example usage:",
34953 "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34957 "name": "Web_Bar_calls",
34972 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34973 "version": "0.0.0",
34974 "filename": "server/api/webbar/index.js",
34975 "groupTitle": "WebBar"
34979 "url": "/api/webbar/hangup",
34980 "title": "hangup webrtc call",
34983 "title": "Example usage:",
34984 "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34988 "name": "Web_Bar_hangup",
34997 "field": "sessionId",
35010 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35011 "version": "0.0.0",
35012 "filename": "server/api/webbar/index.js",
35013 "groupTitle": "WebBar"
35017 "url": "/api/webbar/hold",
35018 "title": "hold webrtc call",
35021 "title": "Example usage:",
35022 "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35026 "name": "Web_Bar_hold",
35035 "field": "sessionId",
35048 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35049 "version": "0.0.0",
35050 "filename": "server/api/webbar/index.js",
35051 "groupTitle": "WebBar"
35055 "url": "/api/webbar/unhold",
35056 "title": "unhold webrtc call",
35059 "title": "Example usage:",
35060 "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35064 "name": "Web_Bar_hold",
35073 "field": "sessionId",
35086 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35087 "version": "0.0.0",
35088 "filename": "server/api/webbar/index.js",
35089 "groupTitle": "WebBar"
35093 "url": "/api/webbar/originate",
35094 "title": "Originate new webrtc call",
35097 "title": "Example usage:",
35098 "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
35102 "name": "Web_Bar_originate",
35111 "field": "callNumber",
35125 "field": "callerId",
35132 "field": "callbackUrl",
35138 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35139 "version": "0.0.0",
35140 "filename": "server/api/webbar/index.js",
35141 "groupTitle": "WebBar"
35145 "url": "/api/webbar/transfer",
35146 "title": "blind transfer webrtc call",
35149 "title": "Example usage:",
35150 "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
35154 "name": "Web_Bar_transfer",
35170 "field": "sessionId",
35177 "field": "transferNumber",
35183 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35184 "version": "0.0.0",
35185 "filename": "server/api/webbar/index.js",
35186 "groupTitle": "WebBar"
35190 "url": "/api/whatsapp/accounts/{id}/users",
35191 "title": "Add agents to a whatsapp account",
35194 "title": "Example usage:",
35195 "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",
35199 "name": "AddAgents",
35200 "group": "Whatsapp_Accounts",
35201 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35202 "version": "0.0.0",
35203 "filename": "server/api/whatsappAccount/index.js",
35204 "groupTitle": "Whatsapp_Accounts"
35208 "url": "/api/whatsapp/accounts",
35209 "title": "Creates a new Account",
35212 "title": "Example usage:",
35213 "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35217 "name": "CreateAccounts",
35218 "group": "Whatsapp_Accounts",
35271 "field": "accountSid",
35278 "field": "authToken",
35285 "field": "notificationTemplate",
35292 "field": "notificationSound",
35299 "field": "notificationShake",
35306 "field": "waitForTheAssignedAgent",
35313 "field": "queueTransfer",
35320 "field": "queueTransferTimeout",
35327 "field": "agentTransfer",
35334 "field": "agentTransferTimeout",
35341 "field": "mandatoryDispositionPauseId",
35342 "description": "<p>Status to put when mandatory disposition is enabled</p>"
35348 "field": "mandatoryDisposition",
35349 "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
35355 "field": "description",
35361 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35362 "version": "0.0.0",
35363 "filename": "server/api/whatsappAccount/index.js",
35364 "groupTitle": "Whatsapp_Accounts"
35368 "url": "/api/whatsapp/accounts/{id}",
35369 "title": "Deletes a Account",
35372 "title": "Example usage:",
35373 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
35377 "name": "DeleteAccounts",
35378 "group": "Whatsapp_Accounts",
35379 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35380 "version": "0.0.0",
35381 "filename": "server/api/whatsappAccount/index.js",
35382 "groupTitle": "Whatsapp_Accounts"
35386 "url": "/api/whatsapp/accounts/describe",
35387 "title": "Gets table info about Accounts",
35390 "title": "Example usage:",
35391 "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
35395 "name": "DescribeAccounts",
35396 "group": "Whatsapp_Accounts",
35397 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35398 "version": "0.0.0",
35399 "filename": "server/api/whatsappAccount/index.js",
35400 "groupTitle": "Whatsapp_Accounts"
35404 "url": "/api/whatsapp/accounts",
35405 "title": "Gets a list of Accounts",
35408 "title": "Example usage:",
35409 "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
35413 "name": "GetAccounts",
35414 "group": "Whatsapp_Accounts",
35415 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35416 "version": "0.0.0",
35417 "filename": "server/api/whatsappAccount/index.js",
35418 "groupTitle": "Whatsapp_Accounts"
35422 "url": "/api/whatsapp/accounts/{id}/users",
35423 "title": "Gets agents from whatsapp account",
35426 "title": "Example usage:",
35427 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
35431 "name": "GetAgents",
35432 "group": "Whatsapp_Accounts",
35433 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35434 "version": "0.0.0",
35435 "filename": "server/api/whatsappAccount/index.js",
35436 "groupTitle": "Whatsapp_Accounts"
35440 "url": "/api/whatsapp/accounts/{id}/users",
35441 "title": "Removes agents from a whatsapp account",
35444 "title": "Example usage:",
35445 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35449 "name": "RemoveAgents",
35450 "group": "Whatsapp_Accounts",
35451 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35452 "version": "0.0.0",
35453 "filename": "server/api/whatsappAccount/index.js",
35454 "groupTitle": "Whatsapp_Accounts"
35458 "url": "/api/whatsapp/accounts/{id}/canned_answers",
35459 "title": "Removes canned answers from account",
35462 "title": "Example usage:",
35463 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35467 "name": "RemoveAnswers",
35468 "group": "Whatsapp_Accounts",
35469 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35470 "version": "0.0.0",
35471 "filename": "server/api/whatsappAccount/index.js",
35472 "groupTitle": "Whatsapp_Accounts"
35476 "url": "/api/whatsapp/accounts/{id}/dispositions",
35477 "title": "Removes dispositions from account",
35480 "title": "Example usage:",
35481 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35485 "name": "RemoveDispositions",
35486 "group": "Whatsapp_Accounts",
35487 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35488 "version": "0.0.0",
35489 "filename": "server/api/whatsappAccount/index.js",
35490 "groupTitle": "Whatsapp_Accounts"
35494 "url": "/api/whatsapp/accounts/{id}",
35495 "title": "Gets a single Account",
35498 "title": "Example usage:",
35499 "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
35503 "name": "ShowAccounts",
35504 "group": "Whatsapp_Accounts",
35505 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35506 "version": "0.0.0",
35507 "filename": "server/api/whatsappAccount/index.js",
35508 "groupTitle": "Whatsapp_Accounts"
35512 "url": "/api/whatsapp/messages/{id}/accept",
35513 "title": "Accepts message",
35516 "title": "Example usage:",
35517 "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35521 "name": "acceptMessage",
35522 "group": "Whatsapp_Accounts",
35523 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35524 "version": "0.0.0",
35525 "filename": "server/api/whatsappMessage/index.js",
35526 "groupTitle": "Whatsapp_Accounts"
35530 "url": "/api/whatsapp/accounts/{id}/canned_answers",
35531 "title": "Creates new canned answer",
35534 "title": "Example usage:",
35535 "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",
35539 "name": "addAnswer",
35540 "group": "Whatsapp_Accounts",
35562 "field": "description",
35575 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35576 "version": "0.0.0",
35577 "filename": "server/api/whatsappAccount/index.js",
35578 "groupTitle": "Whatsapp_Accounts"
35582 "url": "/api/whatsapp/accounts/{id}/applications",
35583 "title": "Creates new applications",
35586 "title": "Example usage:",
35587 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35591 "name": "addApplications",
35592 "group": "Whatsapp_Accounts",
35600 "field": "priority",
35614 "field": "appdata",
35621 "field": "description",
35628 "field": "interval",
35634 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35635 "version": "0.0.0",
35636 "filename": "server/api/whatsappAccount/index.js",
35637 "groupTitle": "Whatsapp_Accounts"
35641 "url": "/api/whatsapp/accounts/{id}/dispositions",
35642 "title": "Creates new disposition",
35645 "title": "Example usage:",
35646 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35650 "name": "addDisposition",
35651 "group": "Whatsapp_Accounts",
35678 "field": "description",
35684 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35685 "version": "0.0.0",
35686 "filename": "server/api/whatsappAccount/index.js",
35687 "groupTitle": "Whatsapp_Accounts"
35691 "url": "/api/whatsapp/accounts/{id}/canned_answers",
35692 "title": "Gets account canned answers",
35695 "title": "Example usage:",
35696 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
35700 "name": "getAnswers",
35701 "group": "Whatsapp_Accounts",
35702 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35703 "version": "0.0.0",
35704 "filename": "server/api/whatsappAccount/index.js",
35705 "groupTitle": "Whatsapp_Accounts"
35709 "url": "/api/whatsapp/accounts/{id}/applications",
35710 "title": "Gets account applications",
35713 "title": "Example usage:",
35714 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
35718 "name": "getApplications",
35719 "group": "Whatsapp_Accounts",
35720 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35721 "version": "0.0.0",
35722 "filename": "server/api/whatsappAccount/index.js",
35723 "groupTitle": "Whatsapp_Accounts"
35727 "url": "/api/whatsapp/accounts/{id}/dispositions",
35728 "title": "Gets account dispositions",
35731 "title": "Example usage:",
35732 "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
35736 "name": "getDispositions",
35737 "group": "Whatsapp_Accounts",
35738 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35739 "version": "0.0.0",
35740 "filename": "server/api/whatsappAccount/index.js",
35741 "groupTitle": "Whatsapp_Accounts"
35745 "url": "/api/whatsapp/accounts/{id}/notify",
35746 "title": "Notify new message",
35749 "title": "Example usage:",
35750 "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",
35755 "group": "Whatsapp_Accounts",
35756 "description": "<p>Motion 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>",
35757 "version": "0.0.0",
35758 "filename": "server/api/whatsappAccount/index.js",
35759 "groupTitle": "Whatsapp_Accounts"
35763 "url": "/api/whatsapp/messages/{id}/reject",
35764 "title": "Rejects message",
35767 "title": "Example usage:",
35768 "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35772 "name": "rejectMessage",
35773 "group": "Whatsapp_Accounts",
35774 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35775 "version": "0.0.0",
35776 "filename": "server/api/whatsappMessage/index.js",
35777 "groupTitle": "Whatsapp_Accounts"
35781 "url": "/api/whatsapp/accounts/{id}/send",
35782 "title": "Send new whatsapp message",
35785 "title": "Example usage:",
35786 "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",
35790 "name": "sendWhatsapp",
35791 "group": "Whatsapp_Accounts",
35792 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35793 "version": "0.0.0",
35794 "filename": "server/api/whatsappAccount/index.js",
35795 "groupTitle": "Whatsapp_Accounts"
35799 "url": "/api/whatsapp/messages/{id}/status",
35800 "title": "Receive message status",
35803 "title": "Example usage:",
35804 "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
35808 "name": "statusMessage",
35809 "group": "Whatsapp_Accounts",
35810 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35811 "version": "0.0.0",
35812 "filename": "server/api/whatsappMessage/index.js",
35813 "groupTitle": "Whatsapp_Accounts"
35817 "url": "/api/whatsapp/accounts/{id}",
35818 "title": "Update an existing Account",
35821 "title": "Example usage:",
35822 "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",
35826 "name": "updateAccounts",
35827 "group": "Whatsapp_Accounts",
35828 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35829 "version": "0.0.0",
35830 "filename": "server/api/whatsappAccount/index.js",
35831 "groupTitle": "Whatsapp_Accounts"
35835 "url": "/api/whatsapp/applications",
35836 "title": "Creates a new Application",
35839 "title": "Example usage:",
35840 "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35844 "name": "CreateApplications",
35845 "group": "Whatsapp_Applications",
35853 "field": "priority",
35867 "field": "appdata",
35874 "field": "description",
35881 "field": "interval",
35887 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35888 "version": "0.0.0",
35889 "filename": "server/api/whatsappApplication/index.js",
35890 "groupTitle": "Whatsapp_Applications"
35894 "url": "/api/whatsapp/applications/{id}",
35895 "title": "Deletes a Application",
35898 "title": "Example usage:",
35899 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35903 "name": "DeleteApplications",
35904 "group": "Whatsapp_Applications",
35905 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35906 "version": "0.0.0",
35907 "filename": "server/api/whatsappApplication/index.js",
35908 "groupTitle": "Whatsapp_Applications"
35912 "url": "/api/whatsapp/applications",
35913 "title": "Gets a list of Applications",
35916 "title": "Example usage:",
35917 "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35921 "name": "GetApplications",
35922 "group": "Whatsapp_Applications",
35923 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35924 "version": "0.0.0",
35925 "filename": "server/api/whatsappApplication/index.js",
35926 "groupTitle": "Whatsapp_Applications"
35930 "url": "/api/whatsapp/applications/{id}",
35931 "title": "Gets a single Application",
35934 "title": "Example usage:",
35935 "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35939 "name": "ShowApplications",
35940 "group": "Whatsapp_Applications",
35941 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35942 "version": "0.0.0",
35943 "filename": "server/api/whatsappApplication/index.js",
35944 "groupTitle": "Whatsapp_Applications"
35948 "url": "/api/whatsapp/applications/{id}",
35949 "title": "Update an existing Application",
35952 "title": "Example usage:",
35953 "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",
35957 "name": "updateApplications",
35958 "group": "Whatsapp_Applications",
35959 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35960 "version": "0.0.0",
35961 "filename": "server/api/whatsappApplication/index.js",
35962 "groupTitle": "Whatsapp_Applications"
35966 "url": "/api/whatsapp/interactions/{id}/tags",
35967 "title": "Add tags to the interaction",
35970 "title": "Example usage:",
35971 "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",
35976 "group": "Whatsapp_Interactions",
35977 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35978 "version": "0.0.0",
35979 "filename": "server/api/whatsappInteraction/index.js",
35980 "groupTitle": "Whatsapp_Interactions"
35984 "url": "/api/whatsapp/interactions",
35985 "title": "Creates a new Interaction",
35988 "title": "Example usage:",
35989 "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35993 "name": "CreateInteractions",
35994 "group": "Whatsapp_Interactions",
36009 "field": "closedAt",
36016 "field": "disposition",
36023 "field": "secondDisposition",
36030 "field": "thirdDisposition",
36051 "field": "read1stAt",
36062 "field": "firstMsgDirection",
36069 "field": "lastMsgAt",
36080 "field": "lastMsgDirection",
36087 "field": "autoreplyExecuted",
36093 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36094 "version": "0.0.0",
36095 "filename": "server/api/whatsappInteraction/index.js",
36096 "groupTitle": "Whatsapp_Interactions"
36100 "url": "/api/whatsapp/interactions/{id}",
36101 "title": "Deletes a Interaction",
36104 "title": "Example usage:",
36105 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
36109 "name": "DeleteInteractions",
36110 "group": "Whatsapp_Interactions",
36111 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36112 "version": "0.0.0",
36113 "filename": "server/api/whatsappInteraction/index.js",
36114 "groupTitle": "Whatsapp_Interactions"
36118 "url": "/api/whatsapp/interactions/describe",
36119 "title": "Gets table info about Interactions",
36122 "title": "Example usage:",
36123 "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
36127 "name": "DescribeInteractions",
36128 "group": "Whatsapp_Interactions",
36129 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36130 "version": "0.0.0",
36131 "filename": "server/api/whatsappInteraction/index.js",
36132 "groupTitle": "Whatsapp_Interactions"
36136 "url": "/api/whatsapp/interactions",
36137 "title": "Gets a list of Interactions",
36140 "title": "Example usage:",
36141 "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
36145 "name": "GetInteractions",
36146 "group": "Whatsapp_Interactions",
36147 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36148 "version": "0.0.0",
36149 "filename": "server/api/whatsappInteraction/index.js",
36150 "groupTitle": "Whatsapp_Interactions"
36154 "url": "/api/whatsapp/interactions/{id}/tags",
36155 "title": "Removes tags from interaction",
36158 "title": "Example usage:",
36159 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36163 "name": "RemoveTags",
36164 "group": "Whatsapp_Interactions",
36165 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36166 "version": "0.0.0",
36167 "filename": "server/api/whatsappInteraction/index.js",
36168 "groupTitle": "Whatsapp_Interactions"
36172 "url": "/api/whatsapp/interactions/{id}",
36173 "title": "Gets a single Interaction",
36176 "title": "Example usage:",
36177 "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
36181 "name": "ShowInteractions",
36182 "group": "Whatsapp_Interactions",
36183 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36184 "version": "0.0.0",
36185 "filename": "server/api/whatsappInteraction/index.js",
36186 "groupTitle": "Whatsapp_Interactions"
36190 "url": "/api/whatsapp/interactions/{id}/messages",
36191 "title": "Creates new messages",
36194 "title": "Example usage:",
36195 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
36199 "name": "addMessage",
36200 "group": "Whatsapp_Interactions",
36226 "field": "direction",
36233 "field": "messageId",
36261 "field": "providerName",
36268 "field": "providerResponse",
36274 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36275 "version": "0.0.0",
36276 "filename": "server/api/whatsappInteraction/index.js",
36277 "groupTitle": "Whatsapp_Interactions"
36281 "url": "/api/whatsapp/interactions/{id}/download",
36282 "title": "Gets interaction",
36285 "title": "Example usage:",
36286 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
36290 "name": "download",
36291 "group": "Whatsapp_Interactions",
36292 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36293 "version": "0.0.0",
36294 "filename": "server/api/whatsappInteraction/index.js",
36295 "groupTitle": "Whatsapp_Interactions"
36299 "url": "/api/whatsapp/interactions/{id}/messages",
36300 "title": "Gets interaction messages",
36303 "title": "Example usage:",
36304 "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
36308 "name": "getMessages",
36309 "group": "Whatsapp_Interactions",
36310 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36311 "version": "0.0.0",
36312 "filename": "server/api/whatsappInteraction/index.js",
36313 "groupTitle": "Whatsapp_Interactions"
36317 "url": "/api/whatsapp/interactions/{id}",
36318 "title": "Update an existing Interaction",
36321 "title": "Example usage:",
36322 "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",
36326 "name": "updateInteractions",
36327 "group": "Whatsapp_Interactions",
36328 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36329 "version": "0.0.0",
36330 "filename": "server/api/whatsappInteraction/index.js",
36331 "groupTitle": "Whatsapp_Interactions"
36335 "url": "/api/whatsapp/messages",
36336 "title": "Creates a new Message",
36339 "title": "Example usage:",
36340 "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36344 "name": "CreateMessages",
36345 "group": "Whatsapp_Messages",
36371 "field": "direction",
36378 "field": "messageId",
36406 "field": "providerName",
36413 "field": "providerResponse",
36419 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36420 "version": "0.0.0",
36421 "filename": "server/api/whatsappMessage/index.js",
36422 "groupTitle": "Whatsapp_Messages"
36426 "url": "/api/whatsapp/messages/{id}",
36427 "title": "Deletes a Message",
36430 "title": "Example usage:",
36431 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
36435 "name": "DeleteMessages",
36436 "group": "Whatsapp_Messages",
36437 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36438 "version": "0.0.0",
36439 "filename": "server/api/whatsappMessage/index.js",
36440 "groupTitle": "Whatsapp_Messages"
36444 "url": "/api/whatsapp/messages/describe",
36445 "title": "Gets table info about Messages",
36448 "title": "Example usage:",
36449 "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
36453 "name": "DescribeMessages",
36454 "group": "Whatsapp_Messages",
36455 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36456 "version": "0.0.0",
36457 "filename": "server/api/whatsappMessage/index.js",
36458 "groupTitle": "Whatsapp_Messages"
36462 "url": "/api/whatsapp/messages",
36463 "title": "Gets a list of Messages",
36466 "title": "Example usage:",
36467 "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
36471 "name": "GetMessages",
36472 "group": "Whatsapp_Messages",
36473 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36474 "version": "0.0.0",
36475 "filename": "server/api/whatsappMessage/index.js",
36476 "groupTitle": "Whatsapp_Messages"
36480 "url": "/api/whatsapp/messages/{id}",
36481 "title": "Gets a single Message",
36484 "title": "Example usage:",
36485 "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
36489 "name": "ShowMessages",
36490 "group": "Whatsapp_Messages",
36491 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36492 "version": "0.0.0",
36493 "filename": "server/api/whatsappMessage/index.js",
36494 "groupTitle": "Whatsapp_Messages"
36498 "url": "/api/whatsapp/messages/{id}",
36499 "title": "Update an existing Message",
36502 "title": "Example usage:",
36503 "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",
36507 "name": "updateMessages",
36508 "group": "Whatsapp_Messages",
36509 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36510 "version": "0.0.0",
36511 "filename": "server/api/whatsappMessage/index.js",
36512 "groupTitle": "Whatsapp_Messages"
36516 "url": "/api/whatsapp/reports/queue",
36517 "title": "Creates a new Whatsapp Queue Report",
36520 "title": "Example usage:",
36521 "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",
36525 "name": "CreateWhatsapp_Queue_Reports",
36526 "group": "Whatsapp_Queue_Reports",
36534 "field": "uniqueid",
36555 "field": "leaveAt",
36562 "field": "acceptAt",
36582 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36583 "version": "0.0.0",
36584 "filename": "server/api/whatsappQueueReport/index.js",
36585 "groupTitle": "Whatsapp_Queue_Reports"
36589 "url": "/api/whatsapp/reports/queue/{id}",
36590 "title": "Deletes a Whatsapp Queue Report",
36593 "title": "Example usage:",
36594 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
36598 "name": "DeleteWhatsapp_Queue_Reports",
36599 "group": "Whatsapp_Queue_Reports",
36600 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36601 "version": "0.0.0",
36602 "filename": "server/api/whatsappQueueReport/index.js",
36603 "groupTitle": "Whatsapp_Queue_Reports"
36607 "url": "/api/whatsapp/reports/queue/describe",
36608 "title": "Gets table info about Whatsapp Queue Reports",
36611 "title": "Example usage:",
36612 "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
36616 "name": "DescribeWhatsapp_Queue_Reports",
36617 "group": "Whatsapp_Queue_Reports",
36618 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36619 "version": "0.0.0",
36620 "filename": "server/api/whatsappQueueReport/index.js",
36621 "groupTitle": "Whatsapp_Queue_Reports"
36625 "url": "/api/whatsapp/reports/queue",
36626 "title": "Gets a list of Whatsapp Queue Reports",
36629 "title": "Example usage:",
36630 "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
36634 "name": "GetWhatsapp_Queue_Reports",
36635 "group": "Whatsapp_Queue_Reports",
36636 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36637 "version": "0.0.0",
36638 "filename": "server/api/whatsappQueueReport/index.js",
36639 "groupTitle": "Whatsapp_Queue_Reports"
36643 "url": "/api/whatsapp/reports/queue/{id}",
36644 "title": "Gets a single Whatsapp Queue Report",
36647 "title": "Example usage:",
36648 "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
36652 "name": "ShowWhatsapp_Queue_Reports",
36653 "group": "Whatsapp_Queue_Reports",
36654 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36655 "version": "0.0.0",
36656 "filename": "server/api/whatsappQueueReport/index.js",
36657 "groupTitle": "Whatsapp_Queue_Reports"
36661 "url": "/api/whatsapp/reports/queue/{id}",
36662 "title": "Update an existing Whatsapp Queue Report",
36665 "title": "Example usage:",
36666 "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",
36670 "name": "updateWhatsapp_Queue_Reports",
36671 "group": "Whatsapp_Queue_Reports",
36672 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36673 "version": "0.0.0",
36674 "filename": "server/api/whatsappQueueReport/index.js",
36675 "groupTitle": "Whatsapp_Queue_Reports"
36679 "url": "/api/whatsapp/queues/{id}/users",
36680 "title": "Add agents to a queue",
36683 "title": "Example usage:",
36684 "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",
36688 "name": "AddAgents",
36689 "group": "Whatsapp_Queues",
36690 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36691 "version": "0.0.0",
36692 "filename": "server/api/whatsappQueue/index.js",
36693 "groupTitle": "Whatsapp_Queues"
36697 "url": "/api/whatsapp/queues/{id}/teams",
36698 "title": "Add teams to a queue",
36701 "title": "Example usage:",
36702 "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",
36706 "name": "AddTeams",
36707 "group": "Whatsapp_Queues",
36708 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36709 "version": "0.0.0",
36710 "filename": "server/api/whatsappQueue/index.js",
36711 "groupTitle": "Whatsapp_Queues"
36715 "url": "/api/whatsapp/queues",
36716 "title": "Creates a new Queue",
36719 "title": "Example usage:",
36720 "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36724 "name": "CreateQueues",
36725 "group": "Whatsapp_Queues",
36740 "field": "timeout",
36752 "field": "strategy",
36759 "field": "description",
36765 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36766 "version": "0.0.0",
36767 "filename": "server/api/whatsappQueue/index.js",
36768 "groupTitle": "Whatsapp_Queues"
36772 "url": "/api/whatsapp/queues/{id}",
36773 "title": "Deletes a Queue",
36776 "title": "Example usage:",
36777 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
36781 "name": "DeleteQueues",
36782 "group": "Whatsapp_Queues",
36783 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36784 "version": "0.0.0",
36785 "filename": "server/api/whatsappQueue/index.js",
36786 "groupTitle": "Whatsapp_Queues"
36790 "url": "/api/whatsapp/queues/describe",
36791 "title": "Gets table info about Queues",
36794 "title": "Example usage:",
36795 "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
36799 "name": "DescribeQueues",
36800 "group": "Whatsapp_Queues",
36801 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36802 "version": "0.0.0",
36803 "filename": "server/api/whatsappQueue/index.js",
36804 "groupTitle": "Whatsapp_Queues"
36808 "url": "/api/whatsapp/queues/{id}/users",
36809 "title": "Gets queue agents",
36812 "title": "Example usage:",
36813 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
36817 "name": "GetAgents",
36818 "group": "Whatsapp_Queues",
36819 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36820 "version": "0.0.0",
36821 "filename": "server/api/whatsappQueue/index.js",
36822 "groupTitle": "Whatsapp_Queues"
36826 "url": "/api/whatsapp/queues/{id}/members",
36827 "title": "GetMembers",
36830 "title": "Example usage:",
36831 "content": "curl https://{domain}/api/whatsapp/queues/{id}/members -v -u {name}:{password}",
36835 "name": "GetMembers",
36836 "group": "Whatsapp_Queues",
36837 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36838 "version": "0.0.0",
36839 "filename": "server/api/whatsappQueue/index.js",
36840 "groupTitle": "Whatsapp_Queues"
36844 "url": "/api/whatsapp/queues",
36845 "title": "Gets a list of Queues",
36848 "title": "Example usage:",
36849 "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
36853 "name": "GetQueues",
36854 "group": "Whatsapp_Queues",
36855 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36856 "version": "0.0.0",
36857 "filename": "server/api/whatsappQueue/index.js",
36858 "groupTitle": "Whatsapp_Queues"
36862 "url": "/api/whatsapp/queues/{id}/teams",
36863 "title": "Gets queues list",
36866 "title": "Example usage:",
36867 "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36871 "name": "GetTeams",
36872 "group": "Whatsapp_Queues",
36873 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36874 "version": "0.0.0",
36875 "filename": "server/api/whatsappQueue/index.js",
36876 "groupTitle": "Whatsapp_Queues"
36880 "url": "/api/whatsapp/queues/{id}/users",
36881 "title": "Removes agents from a queue",
36884 "title": "Example usage:",
36885 "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36889 "name": "RemoveAgents",
36890 "group": "Whatsapp_Queues",
36891 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36892 "version": "0.0.0",
36893 "filename": "server/api/whatsappQueue/index.js",
36894 "groupTitle": "Whatsapp_Queues"
36898 "url": "/api/whatsapp/queues/{id}",
36899 "title": "Gets a single Queue",
36902 "title": "Example usage:",
36903 "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36907 "name": "ShowQueues",
36908 "group": "Whatsapp_Queues",
36909 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36910 "version": "0.0.0",
36911 "filename": "server/api/whatsappQueue/index.js",
36912 "groupTitle": "Whatsapp_Queues"
36916 "url": "/api/whatsapp/queues/{id}",
36917 "title": "Update an existing Queue",
36920 "title": "Example usage:",
36921 "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",
36925 "name": "updateQueues",
36926 "group": "Whatsapp_Queues",
36927 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36928 "version": "0.0.0",
36929 "filename": "server/api/whatsappQueue/index.js",
36930 "groupTitle": "Whatsapp_Queues"
36934 "url": "/api/whatsapp/reports/transfer",
36935 "title": "Creates a new Whatsapp Transfer Report",
36938 "title": "Example usage:",
36939 "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",
36943 "name": "CreateWhatsapp_Transfer_Reports",
36944 "group": "Whatsapp_Transfer_Reports",
36952 "field": "uniqueid",
36971 "field": "transferredAt",
36977 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36978 "version": "0.0.0",
36979 "filename": "server/api/whatsappTransferReport/index.js",
36980 "groupTitle": "Whatsapp_Transfer_Reports"
36984 "url": "/api/whatsapp/reports/transfer/{id}",
36985 "title": "Deletes a Whatsapp Transfer Report",
36988 "title": "Example usage:",
36989 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36993 "name": "DeleteWhatsapp_Transfer_Reports",
36994 "group": "Whatsapp_Transfer_Reports",
36995 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36996 "version": "0.0.0",
36997 "filename": "server/api/whatsappTransferReport/index.js",
36998 "groupTitle": "Whatsapp_Transfer_Reports"
37002 "url": "/api/whatsapp/reports/transfer/describe",
37003 "title": "Gets table info about Whatsapp Transfer Reports",
37006 "title": "Example usage:",
37007 "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
37011 "name": "DescribeWhatsapp_Transfer_Reports",
37012 "group": "Whatsapp_Transfer_Reports",
37013 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37014 "version": "0.0.0",
37015 "filename": "server/api/whatsappTransferReport/index.js",
37016 "groupTitle": "Whatsapp_Transfer_Reports"
37020 "url": "/api/whatsapp/reports/transfer",
37021 "title": "Gets a list of Whatsapp Transfer Reports",
37024 "title": "Example usage:",
37025 "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
37029 "name": "GetWhatsapp_Transfer_Reports",
37030 "group": "Whatsapp_Transfer_Reports",
37031 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37032 "version": "0.0.0",
37033 "filename": "server/api/whatsappTransferReport/index.js",
37034 "groupTitle": "Whatsapp_Transfer_Reports"
37038 "url": "/api/whatsapp/reports/transfer/{id}",
37039 "title": "Gets a single Whatsapp Transfer Report",
37042 "title": "Example usage:",
37043 "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
37047 "name": "ShowWhatsapp_Transfer_Reports",
37048 "group": "Whatsapp_Transfer_Reports",
37049 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37050 "version": "0.0.0",
37051 "filename": "server/api/whatsappTransferReport/index.js",
37052 "groupTitle": "Whatsapp_Transfer_Reports"
37056 "url": "/api/whatsapp/reports/transfer/{id}",
37057 "title": "Update an existing Whatsapp Transfer Report",
37060 "title": "Example usage:",
37061 "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",
37065 "name": "updateWhatsapp_Transfer_Reports",
37066 "group": "Whatsapp_Transfer_Reports",
37067 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37068 "version": "0.0.0",
37069 "filename": "server/api/whatsappTransferReport/index.js",
37070 "groupTitle": "Whatsapp_Transfer_Reports"
37074 "url": "/api/integrations/zendesk/accounts",
37075 "title": "Creates a new Zendesk Account",
37078 "title": "Example usage:",
37079 "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",
37083 "name": "CreateZendesk_Accounts",
37084 "group": "Zendesk_Accounts",
37099 "field": "description",
37106 "field": "username",
37113 "field": "password",
37127 "field": "remoteUri",
37138 "field": "authType",
37145 "field": "serverUrl",
37152 "\"integrationTab\"",
37162 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37163 "version": "0.0.0",
37164 "filename": "server/api/intZendeskAccount/index.js",
37165 "groupTitle": "Zendesk_Accounts"
37169 "url": "/api/integrations/zendesk/accounts/{id}",
37170 "title": "Deletes a Zendesk Account",
37173 "title": "Example usage:",
37174 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
37178 "name": "DeleteZendesk_Accounts",
37179 "group": "Zendesk_Accounts",
37180 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37181 "version": "0.0.0",
37182 "filename": "server/api/intZendeskAccount/index.js",
37183 "groupTitle": "Zendesk_Accounts"
37187 "url": "/api/integrations/zendesk/accounts",
37188 "title": "Gets a list of Zendesk Accounts",
37191 "title": "Example usage:",
37192 "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
37196 "name": "GetZendesk_Accounts",
37197 "group": "Zendesk_Accounts",
37198 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37199 "version": "0.0.0",
37200 "filename": "server/api/intZendeskAccount/index.js",
37201 "groupTitle": "Zendesk_Accounts"
37205 "url": "/api/integrations/zendesk/accounts/{id}",
37206 "title": "Gets a single Zendesk Account",
37209 "title": "Example usage:",
37210 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
37214 "name": "ShowZendesk_Accounts",
37215 "group": "Zendesk_Accounts",
37216 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37217 "version": "0.0.0",
37218 "filename": "server/api/intZendeskAccount/index.js",
37219 "groupTitle": "Zendesk_Accounts"
37223 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
37224 "title": "Creates new configuration",
37227 "title": "Example usage:",
37228 "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",
37232 "name": "addConfiguration",
37233 "group": "Zendesk_Accounts",
37234 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37235 "version": "0.0.0",
37236 "filename": "server/api/intZendeskAccount/index.js",
37237 "groupTitle": "Zendesk_Accounts"
37241 "url": "/api/integrations/zendesk/accounts/{id}/configurations",
37242 "title": "Gets account configurations",
37245 "title": "Example usage:",
37246 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37250 "name": "getConfigurations",
37251 "group": "Zendesk_Accounts",
37252 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37253 "version": "0.0.0",
37254 "filename": "server/api/intZendeskAccount/index.js",
37255 "groupTitle": "Zendesk_Accounts"
37259 "url": "/api/integrations/zendesk/accounts/{id}/fields",
37260 "title": "Gets account fields",
37263 "title": "Example usage:",
37264 "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
37268 "name": "getFields",
37269 "group": "Zendesk_Accounts",
37270 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37271 "version": "0.0.0",
37272 "filename": "server/api/intZendeskAccount/index.js",
37273 "groupTitle": "Zendesk_Accounts"
37277 "url": "/api/integrations/zendesk/accounts/{id}",
37278 "title": "Update an existing Zendesk Account",
37281 "title": "Example usage:",
37282 "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",
37286 "name": "updateZendesk_Accounts",
37287 "group": "Zendesk_Accounts",
37288 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37289 "version": "0.0.0",
37290 "filename": "server/api/intZendeskAccount/index.js",
37291 "groupTitle": "Zendesk_Accounts"
37295 "url": "/api/integrations/zendesk/configurations",
37296 "title": "Creates a new Zendesk Configuration",
37299 "title": "Example usage:",
37300 "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",
37304 "name": "CreateZendesk_Configurations",
37305 "group": "Zendesk_Configurations",
37320 "field": "description",
37326 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37327 "version": "0.0.0",
37328 "filename": "server/api/intZendeskConfiguration/index.js",
37329 "groupTitle": "Zendesk_Configurations"
37333 "url": "/api/integrations/zendesk/configurations/{id}",
37334 "title": "Deletes a Zendesk Configuration",
37337 "title": "Example usage:",
37338 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
37342 "name": "DeleteZendesk_Configurations",
37343 "group": "Zendesk_Configurations",
37344 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37345 "version": "0.0.0",
37346 "filename": "server/api/intZendeskConfiguration/index.js",
37347 "groupTitle": "Zendesk_Configurations"
37351 "url": "/api/integrations/zendesk/configurations",
37352 "title": "Gets a list of Zendesk Configurations",
37355 "title": "Example usage:",
37356 "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
37360 "name": "GetZendesk_Configurations",
37361 "group": "Zendesk_Configurations",
37362 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37363 "version": "0.0.0",
37364 "filename": "server/api/intZendeskConfiguration/index.js",
37365 "groupTitle": "Zendesk_Configurations"
37369 "url": "/api/integrations/zendesk/configurations/{id}",
37370 "title": "Gets a single Zendesk Configuration",
37373 "title": "Example usage:",
37374 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
37378 "name": "ShowZendesk_Configurations",
37379 "group": "Zendesk_Configurations",
37380 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37381 "version": "0.0.0",
37382 "filename": "server/api/intZendeskConfiguration/index.js",
37383 "groupTitle": "Zendesk_Configurations"
37387 "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
37388 "title": "Gets configurations descriptions",
37391 "title": "Example usage:",
37392 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37396 "name": "getDescriptions",
37397 "group": "Zendesk_Configurations",
37398 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37399 "version": "0.0.0",
37400 "filename": "server/api/intZendeskConfiguration/index.js",
37401 "groupTitle": "Zendesk_Configurations"
37405 "url": "/api/integrations/zendesk/configurations/{id}/fields",
37406 "title": "Gets configurations fields",
37409 "title": "Example usage:",
37410 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
37414 "name": "getFields",
37415 "group": "Zendesk_Configurations",
37416 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37417 "version": "0.0.0",
37418 "filename": "server/api/intZendeskConfiguration/index.js",
37419 "groupTitle": "Zendesk_Configurations"
37423 "url": "/api/integrations/zendesk/configurations/{id}/subjects",
37424 "title": "Gets configurations subjects",
37427 "title": "Example usage:",
37428 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37432 "name": "getSubjects",
37433 "group": "Zendesk_Configurations",
37434 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37435 "version": "0.0.0",
37436 "filename": "server/api/intZendeskConfiguration/index.js",
37437 "groupTitle": "Zendesk_Configurations"
37441 "url": "/api/integrations/zendesk/configurations/{id}/tags",
37442 "title": "Gets configurations tags",
37445 "title": "Example usage:",
37446 "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
37451 "group": "Zendesk_Configurations",
37452 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37453 "version": "0.0.0",
37454 "filename": "server/api/intZendeskConfiguration/index.js",
37455 "groupTitle": "Zendesk_Configurations"
37459 "url": "/api/integrations/zendesk/configurations/{id}/tags",
37460 "title": "Sets new tags",
37463 "title": "Example usage:",
37464 "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",
37469 "group": "Zendesk_Configurations",
37470 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37471 "version": "0.0.0",
37472 "filename": "server/api/intZendeskConfiguration/index.js",
37473 "groupTitle": "Zendesk_Configurations"
37477 "url": "/api/integrations/zendesk/configurations/{id}",
37478 "title": "Update an existing Zendesk Configuration",
37481 "title": "Example usage:",
37482 "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",
37486 "name": "updateZendesk_Configurations",
37487 "group": "Zendesk_Configurations",
37488 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37489 "version": "0.0.0",
37490 "filename": "server/api/intZendeskConfiguration/index.js",
37491 "groupTitle": "Zendesk_Configurations"
37495 "url": "/api/integrations/zendesk/fields",
37496 "title": "Creates a new Zendesk Field",
37499 "title": "Example usage:",
37500 "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",
37504 "name": "CreateZendesk_Fields",
37505 "group": "Zendesk_Fields",
37515 "\"customVariable\"",
37527 "field": "content",
37543 "\"customVariable\""
37546 "field": "keyType",
37553 "field": "keyContent",
37560 "field": "idField",
37567 "field": "nameField",
37574 "field": "customField",
37581 "field": "variableName",
37587 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37588 "version": "0.0.0",
37589 "filename": "server/api/intZendeskField/index.js",
37590 "groupTitle": "Zendesk_Fields"
37594 "url": "/api/integrations/zendesk/fields/{id}",
37595 "title": "Deletes a Zendesk Field",
37598 "title": "Example usage:",
37599 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
37603 "name": "DeleteZendesk_Fields",
37604 "group": "Zendesk_Fields",
37605 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37606 "version": "0.0.0",
37607 "filename": "server/api/intZendeskField/index.js",
37608 "groupTitle": "Zendesk_Fields"
37612 "url": "/api/integrations/zendesk/fields",
37613 "title": "Gets a list of Zendesk Fields",
37616 "title": "Example usage:",
37617 "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
37621 "name": "GetZendesk_Fields",
37622 "group": "Zendesk_Fields",
37623 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37624 "version": "0.0.0",
37625 "filename": "server/api/intZendeskField/index.js",
37626 "groupTitle": "Zendesk_Fields"
37630 "url": "/api/integrations/zendesk/fields/{id}",
37631 "title": "Gets a single Zendesk Field",
37634 "title": "Example usage:",
37635 "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
37639 "name": "ShowZendesk_Fields",
37640 "group": "Zendesk_Fields",
37641 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37642 "version": "0.0.0",
37643 "filename": "server/api/intZendeskField/index.js",
37644 "groupTitle": "Zendesk_Fields"
37648 "url": "/api/integrations/zendesk/fields/{id}",
37649 "title": "Update an existing Zendesk Field",
37652 "title": "Example usage:",
37653 "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",
37657 "name": "updateZendesk_Fields",
37658 "group": "Zendesk_Fields",
37659 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37660 "version": "0.0.0",
37661 "filename": "server/api/intZendeskField/index.js",
37662 "groupTitle": "Zendesk_Fields"
37666 "url": "/api/integrations/zoho/accounts",
37667 "title": "Creates a new Zoho Account",
37670 "title": "Example usage:",
37671 "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",
37675 "name": "CreateZoho_Accounts",
37676 "group": "Zoho_Accounts",
37691 "field": "description",
37712 "field": "clientId",
37719 "field": "clientSecret",
37726 "field": "serverUrl",
37740 "field": "refreshToken",
37746 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37747 "version": "0.0.0",
37748 "filename": "server/api/intZohoAccount/index.js",
37749 "groupTitle": "Zoho_Accounts"
37753 "url": "/api/integrations/zoho/accounts/{id}",
37754 "title": "Deletes a Zoho Account",
37757 "title": "Example usage:",
37758 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
37762 "name": "DeleteZoho_Accounts",
37763 "group": "Zoho_Accounts",
37764 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37765 "version": "0.0.0",
37766 "filename": "server/api/intZohoAccount/index.js",
37767 "groupTitle": "Zoho_Accounts"
37771 "url": "/api/integrations/zoho/accounts",
37772 "title": "Gets a list of Zoho Accounts",
37775 "title": "Example usage:",
37776 "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
37780 "name": "GetZoho_Accounts",
37781 "group": "Zoho_Accounts",
37782 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37783 "version": "0.0.0",
37784 "filename": "server/api/intZohoAccount/index.js",
37785 "groupTitle": "Zoho_Accounts"
37789 "url": "/api/integrations/zoho/accounts/{id}",
37790 "title": "Gets a single Zoho Account",
37793 "title": "Example usage:",
37794 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
37798 "name": "ShowZoho_Accounts",
37799 "group": "Zoho_Accounts",
37800 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37801 "version": "0.0.0",
37802 "filename": "server/api/intZohoAccount/index.js",
37803 "groupTitle": "Zoho_Accounts"
37807 "url": "/api/integrations/zoho/accounts/{id}/configurations",
37808 "title": "Creates new configuration",
37811 "title": "Example usage:",
37812 "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",
37816 "name": "addConfiguration",
37817 "group": "Zoho_Accounts",
37818 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37819 "version": "0.0.0",
37820 "filename": "server/api/intZohoAccount/index.js",
37821 "groupTitle": "Zoho_Accounts"
37825 "url": "/api/integrations/zoho/accounts/{id}/configurations",
37826 "title": "Gets account configurations",
37829 "title": "Example usage:",
37830 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37834 "name": "getConfigurations",
37835 "group": "Zoho_Accounts",
37836 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37837 "version": "0.0.0",
37838 "filename": "server/api/intZohoAccount/index.js",
37839 "groupTitle": "Zoho_Accounts"
37843 "url": "/api/integrations/zoho/accounts/{id}/fields",
37844 "title": "Gets account fields",
37847 "title": "Example usage:",
37848 "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
37852 "name": "getFields",
37853 "group": "Zoho_Accounts",
37854 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37855 "version": "0.0.0",
37856 "filename": "server/api/intZohoAccount/index.js",
37857 "groupTitle": "Zoho_Accounts"
37861 "url": "/api/integrations/zoho/accounts/{id}",
37862 "title": "Update an existing Zoho Account",
37865 "title": "Example usage:",
37866 "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",
37870 "name": "updateZoho_Accounts",
37871 "group": "Zoho_Accounts",
37872 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37873 "version": "0.0.0",
37874 "filename": "server/api/intZohoAccount/index.js",
37875 "groupTitle": "Zoho_Accounts"
37879 "url": "/api/integrations/zoho/configurations",
37880 "title": "Creates a new Zoho Configuration",
37883 "title": "Example usage:",
37884 "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",
37888 "name": "CreateZoho_Configurations",
37889 "group": "Zoho_Configurations",
37909 "field": "moduleCreate",
37916 "\"contact_lead\"",
37921 "field": "moduleSearch",
37928 "field": "description",
37934 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37935 "version": "0.0.0",
37936 "filename": "server/api/intZohoConfiguration/index.js",
37937 "groupTitle": "Zoho_Configurations"
37941 "url": "/api/integrations/zoho/configurations/{id}",
37942 "title": "Deletes a Zoho Configuration",
37945 "title": "Example usage:",
37946 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37950 "name": "DeleteZoho_Configurations",
37951 "group": "Zoho_Configurations",
37952 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37953 "version": "0.0.0",
37954 "filename": "server/api/intZohoConfiguration/index.js",
37955 "groupTitle": "Zoho_Configurations"
37959 "url": "/api/integrations/zoho/configurations",
37960 "title": "Gets a list of Zoho Configurations",
37963 "title": "Example usage:",
37964 "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37968 "name": "GetZoho_Configurations",
37969 "group": "Zoho_Configurations",
37970 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37971 "version": "0.0.0",
37972 "filename": "server/api/intZohoConfiguration/index.js",
37973 "groupTitle": "Zoho_Configurations"
37977 "url": "/api/integrations/zoho/configurations/{id}",
37978 "title": "Gets a single Zoho Configuration",
37981 "title": "Example usage:",
37982 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37986 "name": "ShowZoho_Configurations",
37987 "group": "Zoho_Configurations",
37988 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37989 "version": "0.0.0",
37990 "filename": "server/api/intZohoConfiguration/index.js",
37991 "groupTitle": "Zoho_Configurations"
37995 "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37996 "title": "Gets configurations descriptions",
37999 "title": "Example usage:",
38000 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
38004 "name": "getDescriptions",
38005 "group": "Zoho_Configurations",
38006 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38007 "version": "0.0.0",
38008 "filename": "server/api/intZohoConfiguration/index.js",
38009 "groupTitle": "Zoho_Configurations"
38013 "url": "/api/integrations/zoho/configurations/{id}/fields",
38014 "title": "Gets configurations fields",
38017 "title": "Example usage:",
38018 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
38022 "name": "getFields",
38023 "group": "Zoho_Configurations",
38024 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38025 "version": "0.0.0",
38026 "filename": "server/api/intZohoConfiguration/index.js",
38027 "groupTitle": "Zoho_Configurations"
38031 "url": "/api/integrations/zoho/configurations/{id}/subjects",
38032 "title": "Gets configurations subjects",
38035 "title": "Example usage:",
38036 "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
38040 "name": "getSubjects",
38041 "group": "Zoho_Configurations",
38042 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38043 "version": "0.0.0",
38044 "filename": "server/api/intZohoConfiguration/index.js",
38045 "groupTitle": "Zoho_Configurations"
38049 "url": "/api/integrations/zoho/configurations/{id}",
38050 "title": "Update an existing Zoho Configuration",
38053 "title": "Example usage:",
38054 "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",
38058 "name": "updateZoho_Configurations",
38059 "group": "Zoho_Configurations",
38060 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38061 "version": "0.0.0",
38062 "filename": "server/api/intZohoConfiguration/index.js",
38063 "groupTitle": "Zoho_Configurations"
38067 "url": "/api/integrations/zoho/fields",
38068 "title": "Creates a new Zoho Field",
38071 "title": "Example usage:",
38072 "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",
38076 "name": "CreateZoho_Fields",
38077 "group": "Zoho_Fields",
38087 "\"customVariable\"",
38099 "field": "content",
38115 "\"customVariable\""
38118 "field": "keyType",
38125 "field": "keyContent",
38132 "field": "idField",
38139 "field": "nameField",
38146 "field": "customField",
38153 "field": "variableName",
38159 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38160 "version": "0.0.0",
38161 "filename": "server/api/intZohoField/index.js",
38162 "groupTitle": "Zoho_Fields"
38166 "url": "/api/integrations/zoho/fields/{id}",
38167 "title": "Deletes a Zoho Field",
38170 "title": "Example usage:",
38171 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
38175 "name": "DeleteZoho_Fields",
38176 "group": "Zoho_Fields",
38177 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38178 "version": "0.0.0",
38179 "filename": "server/api/intZohoField/index.js",
38180 "groupTitle": "Zoho_Fields"
38184 "url": "/api/integrations/zoho/fields",
38185 "title": "Gets a list of Zoho Fields",
38188 "title": "Example usage:",
38189 "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
38193 "name": "GetZoho_Fields",
38194 "group": "Zoho_Fields",
38195 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38196 "version": "0.0.0",
38197 "filename": "server/api/intZohoField/index.js",
38198 "groupTitle": "Zoho_Fields"
38202 "url": "/api/integrations/zoho/fields/{id}",
38203 "title": "Gets a single Zoho Field",
38206 "title": "Example usage:",
38207 "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
38211 "name": "ShowZoho_Fields",
38212 "group": "Zoho_Fields",
38213 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38214 "version": "0.0.0",
38215 "filename": "server/api/intZohoField/index.js",
38216 "groupTitle": "Zoho_Fields"
38220 "url": "/api/integrations/zoho/fields/{id}",
38221 "title": "Update an existing Zoho Field",
38224 "title": "Example usage:",
38225 "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",
38229 "name": "updateZoho_Fields",
38230 "group": "Zoho_Fields",
38231 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38232 "version": "0.0.0",
38233 "filename": "server/api/intZohoField/index.js",
38234 "groupTitle": "Zoho_Fields"
38239 "title": "Creates a new Cdr",
38242 "title": "Example usage:",
38243 "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38247 "name": "CreateCdrs",
38256 "field": "calldate",
38284 "field": "dcontext",
38291 "field": "channel",
38298 "field": "dstchannel",
38305 "field": "lastapp",
38312 "field": "lastdata",
38319 "field": "duration",
38326 "field": "billsec",
38333 "field": "disposition",
38340 "field": "amaflags",
38347 "field": "accountcode",
38354 "field": "userfield",
38361 "field": "uniqueid",
38368 "field": "linkedid",
38375 "field": "sequence",
38382 "field": "peeraccount",
38402 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38403 "version": "0.0.0",
38404 "filename": "server/api/cdr/index.js",
38405 "groupTitle": "cdr"
38409 "url": "/api/cdr/{id}",
38410 "title": "Deletes a Cdr",
38413 "title": "Example usage:",
38414 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
38418 "name": "DeleteCdrs",
38420 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38421 "version": "0.0.0",
38422 "filename": "server/api/cdr/index.js",
38423 "groupTitle": "cdr"
38427 "url": "/api/cdr/describe",
38428 "title": "Gets table info about Cdrs",
38431 "title": "Example usage:",
38432 "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
38436 "name": "DescribeCdrs",
38438 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38439 "version": "0.0.0",
38440 "filename": "server/api/cdr/index.js",
38441 "groupTitle": "cdr"
38446 "title": "Gets a list of Cdrs",
38449 "title": "Example usage:",
38450 "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
38456 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38457 "version": "0.0.0",
38458 "filename": "server/api/cdr/index.js",
38459 "groupTitle": "cdr"
38463 "url": "/api/cdr/{id}",
38464 "title": "Gets a single Cdr",
38467 "title": "Example usage:",
38468 "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
38472 "name": "ShowCdrs",
38474 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38475 "version": "0.0.0",
38476 "filename": "server/api/cdr/index.js",
38477 "groupTitle": "cdr"
38481 "url": "/api/cdr/{id}",
38482 "title": "Update an existing Cdr",
38485 "title": "Example usage:",
38486 "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38490 "name": "updateCdrs",
38492 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38493 "version": "0.0.0",
38494 "filename": "server/api/cdr/index.js",
38495 "groupTitle": "cdr"
38499 "url": "/api/voiceQueuesLog",
38500 "title": "Creates a new VoiceQueuesLog",
38503 "title": "Example usage:",
38504 "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38508 "name": "CreateVoiceQueuesLogs",
38509 "group": "voiceQueuesLog",
38531 "field": "queuename",
38600 "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38601 "version": "0.0.0",
38602 "filename": "server/api/voiceQueuesLog/index.js",
38603 "groupTitle": "voiceQueuesLog"
38607 "url": "/api/voiceQueuesLog/{id}",
38608 "title": "Deletes a VoiceQueuesLog",
38611 "title": "Example usage:",
38612 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
38616 "name": "DeleteVoiceQueuesLogs",
38617 "group": "voiceQueuesLog",
38618 "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38619 "version": "0.0.0",
38620 "filename": "server/api/voiceQueuesLog/index.js",
38621 "groupTitle": "voiceQueuesLog"
38625 "url": "/api/voiceQueuesLog",
38626 "title": "Gets a list of VoiceQueuesLogs",
38629 "title": "Example usage:",
38630 "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
38634 "name": "GetVoiceQueuesLogs",
38635 "group": "voiceQueuesLog",
38636 "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38637 "version": "0.0.0",
38638 "filename": "server/api/voiceQueuesLog/index.js",
38639 "groupTitle": "voiceQueuesLog"
38643 "url": "/api/voiceQueuesLog/{id}",
38644 "title": "Gets a single VoiceQueuesLog",
38647 "title": "Example usage:",
38648 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
38652 "name": "ShowVoiceQueuesLogs",
38653 "group": "voiceQueuesLog",
38654 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38655 "version": "0.0.0",
38656 "filename": "server/api/voiceQueuesLog/index.js",
38657 "groupTitle": "voiceQueuesLog"
38661 "url": "/api/voiceQueuesLog/{id}",
38662 "title": "Update an existing VoiceQueuesLog",
38665 "title": "Example usage:",
38666 "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38670 "name": "updateVoiceQueuesLogs",
38671 "group": "voiceQueuesLog",
38672 "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38673 "version": "0.0.0",
38674 "filename": "server/api/voiceQueuesLog/index.js",
38675 "groupTitle": "voiceQueuesLog"