define({ "api": [
{
+ "type": "post",
+ "url": "/api/cm/hopper/timezone",
+ "title": "Gets a single TZ data",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper/timezone -d '{\"timezone\": [1]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getTimezone",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopper/index.js",
+ "group": "/var/opt/motion2/server/api/cmHopper/index.js",
+ "groupTitle": "/var/opt/motion2/server/api/cmHopper/index.js"
+ },
+ {
+ "type": "delete",
+ "url": "/api/square/projects/{id}/users",
+ "title": "Removes user permissions from a Project",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "version": "0.0.0",
+ "filename": "server/api/squareProject/index.js",
+ "group": "/var/opt/motion2/server/api/squareProject/index.js",
+ "groupTitle": "/var/opt/motion2/server/api/squareProject/index.js",
+ "name": "DeleteApiSquareProjectsIdUsers"
+ },
+ {
+ "type": "get",
+ "url": "/api/square/projects/{id}/users",
+ "title": "Gets users permissions from Project",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "version": "0.0.0",
+ "filename": "server/api/squareProject/index.js",
+ "group": "/var/opt/motion2/server/api/squareProject/index.js",
+ "groupTitle": "/var/opt/motion2/server/api/squareProject/index.js",
+ "name": "GetApiSquareProjectsIdUsers"
+ },
+ {
+ "type": "post",
+ "url": "/api/square/projects/{id}/users",
+ "title": "Adds user permissions to a Project",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "version": "0.0.0",
+ "filename": "server/api/squareProject/index.js",
+ "group": "/var/opt/motion2/server/api/squareProject/index.js",
+ "groupTitle": "/var/opt/motion2/server/api/squareProject/index.js",
+ "name": "PostApiSquareProjectsIdUsers"
+ },
+ {
"type": "delete",
"url": "/api/actions/{id}",
"title": "Deletes a Action",
},
{
"type": "post",
- "url": "/api/auth/local",
+ "url": "/api/auth/activedirectory",
"title": "Creates a new User token",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "content": "curl https://{domain}/api/auth/activedirectory -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
"type": "json"
}
],
},
"description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
- "filename": "server/api/authLocal/index.js",
+ "filename": "server/api/authActiveDirectory/index.js",
"groupTitle": "Authentication"
},
{
},
{
"type": "post",
+ "url": "/api/auth/local",
+ "title": "Creates a new User token",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Local_login",
+ "group": "Authentication",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "password",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/authLocal/index.js",
+ "groupTitle": "Authentication"
+ },
+ {
+ "type": "post",
"url": "/api/automations",
"title": "Creates a new Automation",
"examples": [
"group": "Body",
"type": "String",
"optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "note",
"description": ""
},
"optional": true,
"field": "customerPort",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "vidaooSessionId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "autoreplyExecuted",
+ "description": ""
}
]
}
"optional": true,
"field": "readAt",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
}
]
}
"groupTitle": "Chat_Interactions"
},
{
+ "type": "post",
+ "url": "/api/chat/interactions/{id}/vidaoo",
+ "title": "Create Vidaoo Session",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "createVidaooSession",
+ "group": "Chat_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInteraction/index.js",
+ "groupTitle": "Chat_Interactions"
+ },
+ {
"type": "put",
"url": "/api/chat/interactions/{id}/custom_update",
"title": "Update interaction",
"optional": true,
"field": "readAt",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
}
]
}
},
{
"group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "waitForTheAssignedQueue",
+ "description": ""
+ },
+ {
+ "group": "Body",
"type": "String",
"optional": true,
"field": "alignment",
"group": "Body",
"type": "String",
"optional": true,
+ "field": "labelText",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "messagesAlignment",
"description": ""
},
"optional": true,
"field": "mandatoryDisposition",
"description": "<p>Enabled/disables mandatory dispo on a queue</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "vidaooEscalation",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "vidaooApiKey",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "vidaooTopic",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "vidaooNote",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "vidaooMetadata",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "openNewInteraction",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "subjectOffline",
+ "description": ""
}
]
}
"optional": false,
"field": "name",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
}
]
}
"group": "Body",
"type": "String",
"optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "note",
"description": ""
},
"optional": true,
"field": "customerPort",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "vidaooSessionId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "autoreplyExecuted",
+ "description": ""
}
]
}
},
{
"type": "post",
+ "url": "/api/cloudProviders",
+ "title": "Creates a new CloudProvider",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateCloudProviders",
+ "group": "CloudProviders",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"AmazonAWS\"",
+ "\"Google\""
+ ],
+ "optional": false,
+ "field": "service",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "data1",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "data2",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cloudProvider/index.js",
+ "groupTitle": "CloudProviders"
+ },
+ {
+ "type": "delete",
+ "url": "/api/cloudProviders/{id}",
+ "title": "Deletes a CloudProvider",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteCloudProviders",
+ "group": "CloudProviders",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cloudProvider/index.js",
+ "groupTitle": "CloudProviders"
+ },
+ {
+ "type": "get",
+ "url": "/api/cloudProviders",
+ "title": "Gets a list of CloudProviders",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetCloudProviders",
+ "group": "CloudProviders",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
+ "version": "0.0.0",
+ "filename": "server/api/cloudProvider/index.js",
+ "groupTitle": "CloudProviders"
+ },
+ {
+ "type": "get",
+ "url": "/api/cloudProviders/oauth2/microsoft/authorize/{id}",
+ "title": "Generates the Microsoft Identity platform authorization url",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cloudProviders/oauth2/microsoft/authorize/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "Oauth2MicrosoftAuthorize",
+ "group": "CloudProviders",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cloudProvider/index.js",
+ "groupTitle": "CloudProviders"
+ },
+ {
+ "type": "post",
+ "url": "/api/cloudProviders/oauth2/microsoft/callback",
+ "title": "Receives an authorization code from Microsoft Identity platform",
+ "name": "Oauth2MicrosoftCallback",
+ "group": "CloudProviders",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cloudProvider/index.js",
+ "groupTitle": "CloudProviders"
+ },
+ {
+ "type": "get",
+ "url": "/api/cloudProviders/{id}",
+ "title": "Gets a single CloudProvider",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowCloudProviders",
+ "group": "CloudProviders",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cloudProvider/index.js",
+ "groupTitle": "CloudProviders"
+ },
+ {
+ "type": "put",
+ "url": "/api/cloudProviders/{id}",
+ "title": "Update an existing CloudProvider",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "updateCloudProviders",
+ "group": "CloudProviders",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cloudProvider/index.js",
+ "groupTitle": "CloudProviders"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm_contact_has_items",
+ "title": "Creates a new CmContactHasItem",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateCmContactHasItems",
+ "group": "CmContactHasItems",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "CmContactId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "item",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "ItemTypeId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "ItemClass",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "OrderBy",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContactHasItem/index.js",
+ "groupTitle": "CmContactHasItems"
+ },
+ {
+ "type": "delete",
+ "url": "/api/cm_contact_has_items/{id}",
+ "title": "Deletes a CmContactHasItem",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm_contact_has_items/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteCmContactHasItems",
+ "group": "CmContactHasItems",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContactHasItem/index.js",
+ "groupTitle": "CmContactHasItems"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm_contact_has_items",
+ "title": "Gets a list of CmContactHasItems",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm_contact_has_items -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetCmContactHasItems",
+ "group": "CmContactHasItems",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContactHasItem/index.js",
+ "groupTitle": "CmContactHasItems"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm_contact_has_items/{id}",
+ "title": "Gets a single CmContactHasItem",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm_contact_has_items/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowCmContactHasItems",
+ "group": "CmContactHasItems",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContactHasItem/index.js",
+ "groupTitle": "CmContactHasItems"
+ },
+ {
+ "type": "put",
+ "url": "/api/cm_contact_has_items/{id}",
+ "title": "Update an existing CmContactHasItem",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateCmContactHasItems",
+ "group": "CmContactHasItems",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContactHasItem/index.js",
+ "groupTitle": "CmContactHasItems"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm_hopper_additional_phones",
+ "title": "Creates a new CmHopperAdditionalPhone",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateCmHopperAdditionalPhones",
+ "group": "CmHopperAdditionalPhones",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "CmHopperId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "phone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "OrderBy",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "scheduledat",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countbusyretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countcongestionretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countnoanswerretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countnosuchnumberretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countdropretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countabandonedretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countmachineretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countagentrejectretry",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperAdditionalPhone/index.js",
+ "groupTitle": "CmHopperAdditionalPhones"
+ },
+ {
+ "type": "delete",
+ "url": "/api/cm_hopper_additional_phones/{id}",
+ "title": "Deletes a CmHopperAdditionalPhone",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteCmHopperAdditionalPhones",
+ "group": "CmHopperAdditionalPhones",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperAdditionalPhone/index.js",
+ "groupTitle": "CmHopperAdditionalPhones"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm_hopper_additional_phones",
+ "title": "Gets a list of CmHopperAdditionalPhones",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm_hopper_additional_phones -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetCmHopperAdditionalPhones",
+ "group": "CmHopperAdditionalPhones",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperAdditionalPhone/index.js",
+ "groupTitle": "CmHopperAdditionalPhones"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm_hopper_additional_phones/{id}",
+ "title": "Gets a single CmHopperAdditionalPhone",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowCmHopperAdditionalPhones",
+ "group": "CmHopperAdditionalPhones",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperAdditionalPhone/index.js",
+ "groupTitle": "CmHopperAdditionalPhones"
+ },
+ {
+ "type": "put",
+ "url": "/api/cm_hopper_additional_phones/{id}",
+ "title": "Update an existing CmHopperAdditionalPhone",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateCmHopperAdditionalPhones",
+ "group": "CmHopperAdditionalPhones",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopperAdditionalPhone/index.js",
+ "groupTitle": "CmHopperAdditionalPhones"
+ },
+ {
+ "type": "post",
"url": "/api/cm/companies",
"title": "Creates a new Company",
"examples": [
"groupTitle": "Cm_Contacts"
},
{
+ "type": "post",
+ "url": "/api/cm/contacts/{id}/duplicatePhones",
+ "title": "Sets new contact additional phones",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/{id}/duplicateAdditionalPhones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "duplicateAdditionalPhones",
+ "group": "Cm_Contacts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_Contacts"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/contacts/{id}/phones",
+ "title": "Gets contact phones",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/{id}/phones -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getAdditionalPhones",
+ "group": "Cm_Contacts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_Contacts"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/contacts/{id}/journey",
+ "title": "Gets customer journey",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getJourney",
+ "group": "Cm_Contacts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_Contacts"
+ },
+ {
"type": "get",
"url": "/api/cm/contacts/{id}/jscripty_sessions",
"title": "Gets contact hopper blacks",
},
{
"type": "post",
+ "url": "/api/cm/contacts/{id}/rescheduleAdditionalPhones",
+ "title": "Sets new contact additional phones",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/{id}/rescheduleAdditionalPhones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "rescheduleAdditionalPhones",
+ "group": "Cm_Contacts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_Contacts"
+ },
+ {
+ "type": "post",
+ "url": "/api/cm/contacts/{id}/phones",
+ "title": "Sets new contact phones",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/{id}/phones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "setAdditionalPhones",
+ "group": "Cm_Contacts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_Contacts"
+ },
+ {
+ "type": "post",
"url": "/api/cm/contacts/{id}/tags",
"title": "Sets new tags",
"examples": [
"optional": true,
"field": "CampaignId",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countnosuchnumberretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countdropretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countabandonedretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countmachineretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countagentrejectretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "OrderBy",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "dialTimezone",
+ "description": ""
}
]
}
"optional": true,
"field": "edited",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countnosuchnumberretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countdropretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countabandonedretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countmachineretry",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "countagentrejectretry",
+ "description": ""
}
]
}
"groupTitle": "Cm_Hopper"
},
{
+ "type": "get",
+ "url": "/api/cm/hopper/{id}/previewrecall",
+ "title": "Gets Preview Dialer Contacts for Recall",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper/{id}/previewrecall \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getPreviewRecall",
+ "group": "Cm_Hopper",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopper/index.js",
+ "groupTitle": "Cm_Hopper"
+ },
+ {
+ "type": "get",
+ "url": "/api/cm/hopper/timezones",
+ "title": "Gets TZs list",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper/timezones -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getTimezones",
+ "group": "Cm_Hopper",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopper/index.js",
+ "groupTitle": "Cm_Hopper"
+ },
+ {
"type": "put",
"url": "/api/cm/hopper/{id}",
"title": "Update an existing Hopper",
"optional": false,
"field": "name",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
}
]
}
},
{
"type": "get",
+ "url": "/api/cm/lists/global_fields",
+ "title": "Gets GLOBAL Custom Fields",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/lists/global_fields -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getGlobalCustomFields",
+ "group": "Cm_Lists",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmList/index.js",
+ "groupTitle": "Cm_Lists"
+ },
+ {
+ "type": "get",
"url": "/api/cm/lists/{id}/contacts/csv",
"title": "Gets CSV List Contacts",
"examples": [
},
{
"type": "post",
+ "url": "/api/cm/contacts/uploadUpdates/:id",
+ "title": "Import existing contacts by csv",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/uploadUpdates/:id -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "importUpdates",
+ "group": "Cm_contacts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_contacts"
+ },
+ {
+ "type": "post",
"url": "/api/cm/contacts/upload",
"title": "Upload csv",
"examples": [
},
{
"type": "post",
+ "url": "/api/contact_item_types",
+ "title": "Creates a new ContactItemType",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateContactItemTypes",
+ "group": "ContactItemType",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "OrderBy",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "rgbBackgroundColor",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/contactItemType/index.js",
+ "groupTitle": "ContactItemType"
+ },
+ {
+ "type": "delete",
+ "url": "/api/contact_item_types/{id}",
+ "title": "Deletes a ContactItemType",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/contact_item_types/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteContactItemTypes",
+ "group": "ContactItemType",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/contactItemType/index.js",
+ "groupTitle": "ContactItemType"
+ },
+ {
+ "type": "get",
+ "url": "/api/contact_item_types",
+ "title": "Gets a list of ContactItemTypes",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/contact_item_types -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetContactItemTypes",
+ "group": "ContactItemType",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
+ "version": "0.0.0",
+ "filename": "server/api/contactItemType/index.js",
+ "groupTitle": "ContactItemType"
+ },
+ {
+ "type": "get",
+ "url": "/api/contact_item_types/{id}",
+ "title": "Gets a single ContactItemType",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/contact_item_types/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowContactItemTypes",
+ "group": "ContactItemType",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/contactItemType/index.js",
+ "groupTitle": "ContactItemType"
+ },
+ {
+ "type": "put",
+ "url": "/api/contact_item_types/{id}",
+ "title": "Update an existing ContactItemType",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateContactItemTypes",
+ "group": "ContactItemType",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/contactItemType/index.js",
+ "groupTitle": "ContactItemType"
+ },
+ {
+ "type": "post",
"url": "/api/cm/custom_field",
"title": "Create a new custom field",
"examples": [
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "serverUrl",
"description": ""
},
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
"optional": false,
"field": "name",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
}
]
}
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "serverUrl",
"description": ""
},
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
},
{
"group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "waitForTheAssignedQueue",
+ "description": ""
+ },
+ {
+ "group": "Body",
"type": "Boolean",
"optional": true,
"field": "queueTransfer",
"optional": false,
"field": "name",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
}
]
}
"group": "Body",
"type": "String",
"optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "note",
"description": ""
},
"group": "Body",
"type": "String",
"optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "note",
"description": ""
},
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "serverUrl",
"description": ""
}
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "serverUrl",
"description": ""
}
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
"optional": true,
"field": "dialCutDigit",
"description": "<p>Cut Digit (min:1, max:15)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialNoSuchNumberMaxRetry",
+ "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialNoSuchNumberRetryFrequency",
+ "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialDropMaxRetry",
+ "description": "<p>#Drop Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialDropRetryFrequency",
+ "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAbandonedMaxRetry",
+ "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAbandonedRetryFrequency",
+ "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialMachineMaxRetry",
+ "description": "<p>#Machine Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialMachineRetryFrequency",
+ "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAgentRejectMaxRetry",
+ "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAgentRejectRetryFrequency",
+ "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
}
]
}
"Body": [
{
"group": "Body",
- "type": "String",
+ "type": "Text",
"optional": true,
"field": "question",
"description": ""
"Body": [
{
"group": "Body",
- "type": "String",
+ "type": "Text",
"optional": true,
"field": "question",
"description": ""
"groupTitle": "License"
},
{
+ "type": "get",
+ "url": "/api/mail_interaction_has_tags/describe",
+ "title": "Gets table info about Mail Iteraction Tags",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/mail_interaction_has_tags/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeMailInteractionTags",
+ "group": "MailInteractionTags",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/mailInteractionHasTag/index.js",
+ "groupTitle": "MailInteractionTags"
+ },
+ {
"type": "post",
"url": "/api/mail/accounts/{id}/users",
"title": "Add agents to a mail account",
"optional": false,
"field": "name",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
}
]
}
"group": "Body",
"type": "String",
"optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "note",
"description": ""
},
},
{
"group": "Body",
- "type": "Text",
- "optional": true,
- "field": "lastMsgBody",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Text",
+ "type": "Boolean",
"optional": true,
- "field": "lastMsgText",
+ "field": "autoreplyExecuted",
"description": ""
}
]
"group": "Body",
"type": "String",
"optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "note",
"description": ""
},
},
{
"group": "Body",
- "type": "Text",
- "optional": true,
- "field": "lastMsgBody",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Text",
+ "type": "Boolean",
"optional": true,
- "field": "lastMsgText",
+ "field": "autoreplyExecuted",
"description": ""
}
]
"optional": true,
"field": "originCc",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"Email\"",
+ "\"Chat\""
+ ],
+ "optional": false,
+ "field": "originChannel",
+ "description": ""
}
]
}
},
{
"group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "waitForTheAssignedQueue",
+ "description": ""
+ },
+ {
+ "group": "Body",
"type": "String",
"optional": true,
"field": "mapKey",
"optional": false,
"field": "name",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
}
]
}
],
"name": "notify",
"group": "Openchannel_Accounts",
- "description": "<p>Motion 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>",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>Follow this link to check the documentation: <pre><a target="_blank" href="https://xcally.atlassian.net/wiki/spaces/XMV/pages/1896252245/New+Channels+Configuration+Steps"</a></pre></p>",
"version": "0.0.0",
"filename": "server/api/openchannelAccount/index.js",
"groupTitle": "Openchannel_Accounts"
"group": "Body",
"type": "String",
"optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "note",
"description": ""
},
"optional": true,
"field": "from",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "autoreplyExecuted",
+ "description": ""
}
]
}
"optional": true,
"field": "readAt",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
}
]
}
"optional": true,
"field": "readAt",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
}
]
}
"groupTitle": "Plugins"
},
{
- "type": "post",
+ "type": "get",
"url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
"title": "Redirect a plugin request to the specified path",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
+ "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
"type": "json"
}
],
"name": "webhookPlugin",
"group": "Plugins",
- "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
"filename": "server/api/plugin/index.js",
"groupTitle": "Plugins"
},
{
- "type": "get",
+ "type": "post",
"url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
"title": "Redirect a plugin request to the specified path",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
+ "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
"type": "json"
}
],
"name": "webhookPlugin",
"group": "Plugins",
- "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
"filename": "server/api/plugin/index.js",
"groupTitle": "Plugins"
},
{
"type": "get",
- "url": "/api/rpc/outbound",
- "title": "Gets a list of RTOutbound",
+ "url": "/api/rpc/voice/queues",
+ "title": "Gets a list of RTVoiceQueues",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
+ "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
"type": "json"
}
],
"name": "RTVoiceQueues",
"group": "RPC_Realtime",
- "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>",
+ "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>",
"version": "0.0.0",
"filename": "server/api/rpc/index.js",
"groupTitle": "RPC_Realtime"
},
{
"type": "get",
- "url": "/api/rpc/voice/queues",
- "title": "Gets a list of RTVoiceQueues",
+ "url": "/api/rpc/outbound",
+ "title": "Gets a list of RTOutbound",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
+ "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
"type": "json"
}
],
"name": "RTVoiceQueues",
"group": "RPC_Realtime",
- "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>",
+ "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>",
"version": "0.0.0",
"filename": "server/api/rpc/index.js",
"groupTitle": "RPC_Realtime"
"groupTitle": "RPC_Realtime"
},
{
+ "type": "put",
+ "url": "/api/rpc/voice/{id}/queues",
+ "title": "Updates a single VoiceQueue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "UpdateVoiceQueues",
+ "group": "RPC_Realtime",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
"type": "post",
"url": "/api/rpc/agents/:id/notify",
"title": "Notify message to a specific agent",
},
{
"type": "get",
+ "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
+ "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "openchannelQueuesIdWaitingInteractions",
+ "group": "RPC_Realtime",
+ "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>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
"url": "/api/rpc/openchannel/queues/waitinginteractions",
"title": "Gets a list of openchannelQueuesWaitingInteractions",
"examples": [
"groupTitle": "RPC_Realtime"
},
{
+ "type": "get",
+ "url": "/api/realtime/agents",
+ "title": "Gets realtime agents info",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/realtime/agents -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getAgents",
+ "group": "Realtime",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/realtime/index.js",
+ "groupTitle": "Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/realtime/queues",
+ "title": "Gets realtime queues info",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/realtime/queues -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getQueues",
+ "group": "Realtime",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/realtime/index.js",
+ "groupTitle": "Realtime"
+ },
+ {
"type": "post",
"url": "/api/integrations/salesforce/accounts",
"title": "Creates a new Salesforce Account",
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "serverUrl",
"description": ""
},
"allowedValues": [
"\"contact_lead\"",
"\"contact\"",
- "\"lead\""
+ "\"lead\"",
+ "\"account_contact_lead\"",
+ "\"account\""
],
"optional": true,
"field": "moduleSearch",
"allowedValues": [
"\"nothing\"",
"\"contact\"",
- "\"lead\""
+ "\"lead\"",
+ "\"account\""
],
"optional": true,
"field": "moduleCreate",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "leadId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "additionalSearchAccount",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "additionalSearchContact",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "additionalSearchLead",
+ "description": ""
}
]
}
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "serverUrl",
"description": ""
}
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
},
{
"type": "get",
+ "url": "/api/settings/now",
+ "title": "Get Server Current Date",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/settings/now -v -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDate",
+ "group": "Settings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/setting/index.js",
+ "groupTitle": "Settings"
+ },
+ {
+ "type": "get",
"url": "/api/settings/{id}/favicon",
"title": "Get Favicon",
"examples": [
"\"clicksend\"",
"\"plivo\"",
"\"clickatell\"",
+ "\"bandwidth\"",
"\"csc\"",
"\"infobip\"",
"\"intelepeer\""
"group": "Body",
"type": "String",
"optional": true,
+ "field": "applicationId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "accountId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "senderString",
"description": ""
},
},
{
"group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "waitForTheAssignedQueue",
+ "description": ""
+ },
+ {
+ "group": "Body",
"type": "Boolean",
"optional": true,
"field": "queueTransfer",
"optional": false,
"field": "name",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
}
]
}
"group": "Body",
"type": "String",
"optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "note",
"description": ""
},
"optional": false,
"field": "lastMsgDirection",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "autoreplyExecuted",
+ "description": ""
}
]
}
"optional": true,
"field": "secret",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
}
]
}
"optional": true,
"field": "secret",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
}
]
}
"optional": false,
"field": "direction",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
}
]
}
"optional": true,
"field": "production",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "savedAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "publishedAt",
+ "description": ""
}
]
}
"groupTitle": "Square_Projects"
},
{
- "type": "post",
- "url": "/api/square/projects/{id}/users",
- "title": "Adds user permissions to a Project",
- "examples": [
- {
- "title": "Example usage:",
- "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",
- "type": "json"
- }
- ],
- "name": "addUsers",
- "group": "Square_Projects",
- "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
- "version": "0.0.0",
- "filename": "server/api/squareProject/index.js",
- "groupTitle": "Square_Projects"
- },
- {
- "type": "get",
- "url": "/api/square/projects/{id}/users",
- "title": "Gets users permissions from Project",
- "examples": [
- {
- "title": "Example usage:",
- "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
- "type": "json"
- }
- ],
- "name": "getUsers",
- "group": "Square_Projects",
- "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
- "version": "0.0.0",
- "filename": "server/api/squareProject/index.js",
- "groupTitle": "Square_Projects"
- },
- {
- "type": "delete",
- "url": "/api/square/projects/{id}/users",
- "title": "Removes user permissions from a Project",
- "examples": [
- {
- "title": "Example usage:",
- "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
- "type": "json"
- }
- ],
- "name": "removeUsers",
- "group": "Square_Projects",
- "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
- "version": "0.0.0",
- "filename": "server/api/squareProject/index.js",
- "groupTitle": "Square_Projects"
- },
- {
"type": "put",
"url": "/api/square/projects/{id}",
"title": "Update an existing Project",
},
{
"type": "delete",
- "url": "/api/square/recordings/{id}/delete",
+ "url": "/api/square/recordings/{id}",
"title": "Delete recording",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/square/recordings/{id}/delete -v -u {name}:{password} -X DELETE",
+ "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",
"type": "json"
}
],
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "serverUrl",
"description": ""
}
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
},
{
"type": "get",
+ "url": "/api/tags/describe",
+ "title": "Gets table info about Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/tags/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeTags",
+ "group": "Tags",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/tag/index.js",
+ "groupTitle": "Tags"
+ },
+ {
+ "type": "get",
"url": "/api/tags",
"title": "Gets a list of Tags",
"examples": [
},
{
"type": "delete",
- "url": "/api/fax/queues/{id}/teams",
+ "url": "/api/whatsapp/queues/{id}/teams",
"title": "Remove teams from a queue",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
+ "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
"type": "json"
}
],
"group": "Teams",
"description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
- "filename": "server/api/faxQueue/index.js",
+ "filename": "server/api/whatsappQueue/index.js",
"groupTitle": "Teams"
},
{
"type": "delete",
- "url": "/api/mail/queues/{id}/teams",
+ "url": "/api/voice/queues/{id}/teams",
"title": "Remove teams from a queue",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
+ "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
"type": "json"
}
],
"group": "Teams",
"description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
- "filename": "server/api/mailQueue/index.js",
+ "filename": "server/api/voiceQueue/index.js",
"groupTitle": "Teams"
},
{
"type": "delete",
- "url": "/api/voice/queues/{id}/teams",
+ "url": "/api/sms/queues/{id}/teams",
"title": "Remove teams from a queue",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
+ "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
"type": "json"
}
],
"group": "Teams",
"description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
- "filename": "server/api/voiceQueue/index.js",
+ "filename": "server/api/smsQueue/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "delete",
+ "url": "/api/voice/Prefixes/{id}/teams",
+ "title": "Remove teams from a voice prefix",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveTeams",
+ "group": "Teams",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voicePrefix/index.js",
"groupTitle": "Teams"
},
{
},
{
"type": "delete",
- "url": "/api/sms/queues/{id}/teams",
+ "url": "/api/mail/queues/{id}/teams",
"title": "Remove teams from a queue",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
+ "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
"type": "json"
}
],
"group": "Teams",
"description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
- "filename": "server/api/smsQueue/index.js",
+ "filename": "server/api/mailQueue/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "delete",
+ "url": "/api/fax/queues/{id}/teams",
+ "title": "Remove teams from a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveTeams",
+ "group": "Teams",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/faxQueue/index.js",
"groupTitle": "Teams"
},
{
},
{
"type": "post",
+ "url": "/api/userNotifications",
+ "title": "Send notification to user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Send",
+ "group": "UserNotifications",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userNotification/index.js",
+ "groupTitle": "UserNotifications"
+ },
+ {
+ "type": "post",
"url": "/api/userProfile/resources",
"title": "Creates a new User Profile Resource",
"examples": [
"optional": true,
"field": "description",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "privacyEnabled",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "downloadAttachments",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "downloadCallySquareRecordings",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "downloadContactManagerLists",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "downloadJscriptySessions",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "downloadOmnichannelInteractions",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "downloadScreenRecordings",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "downloadVoiceRecordings",
+ "description": ""
}
]
}
"groupTitle": "User_Profiles"
},
{
+ "type": "put",
+ "url": "/api/user-settings/{id}",
+ "title": "Update an existing User Setting",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateUserSettings",
+ "group": "User_Settings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user-setting/index.js",
+ "groupTitle": "User_Settings"
+ },
+ {
"type": "post",
"url": "/api/users/{id}/chat_interactions",
"title": "Add chat interaction tabs to an agent",
},
{
"type": "post",
- "url": "/api/users/{id}/square_projects",
- "title": "Add a Square Project to a user",
+ "url": "/api/users/{id}/teams",
+ "title": "Add teams to an agent",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/users/{id}/square_projects -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
"type": "json"
}
],
- "name": "AddSquareProjects",
+ "name": "AddTeams",
"group": "Users",
"description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
},
{
"type": "post",
- "url": "/api/users/{id}/teams",
- "title": "Add teams to an agent",
+ "url": "/api/users/{id}/whatsapp_accounts",
+ "title": "Add a Whatsapp Account to a user",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "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",
"type": "json"
}
],
- "name": "AddTeams",
+ "name": "AddWhatsappAccounts",
"group": "Users",
"description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
},
{
"type": "post",
- "url": "/api/users/create_many",
- "title": "Creates many Users",
+ "url": "/api/users/{id}/whatsapp_interactions",
+ "title": "Add Whatsapp interaction tabs to an agent",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/users/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "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",
"type": "json"
}
],
- "name": "BulkCreateUsers",
+ "name": "AddWhatsappInteractions",
"group": "Users",
- "parameter": {
- "fields": {
- "Body": [
- {
- "group": "Body",
- "type": "String",
- "optional": false,
- "field": "name",
- "description": "<p>The name of the user</p>"
- },
- {
- "group": "Body",
- "type": "String",
- "optional": false,
- "field": "fullname",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "alias",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": false,
- "field": "email",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"admin\"",
- "\"user\"",
- "\"agent\"",
- "\"telephone\""
- ],
- "optional": false,
- "field": "role",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": false,
- "field": "password",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "provider",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": false,
- "field": "internal",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "salt",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "phone",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "mobile",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "address",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "zipcode",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "userpic",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "city",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "country",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "online",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "lastLoginAt",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "voicePause",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "chatPause",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "mailPause",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "faxPause",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "smsPause",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "openchannelPause",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "pauseType",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "lastPauseAt",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "chatCapacity",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "mailCapacity",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "faxCapacity",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "smsCapacity",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "openchannelCapacity",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarAutoAnswer",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarEnableSettings",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "phoneBarListenPort",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "phoneBarExpires",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarRemoteControl",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "phoneBarRemoteControlPort",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarEnableRecording",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarRingInUse",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "chanspy",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "description",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "host",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "ipaddr",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "port",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "regseconds",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "fullcontact",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "regserver",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "useragent",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "lastms",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"friend\"",
- "\"user\"",
- "\"peer\""
- ],
- "optional": true,
- "field": "type",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "context",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"ALLOWED_NOT_SCREENED\"",
- "\"ALLOWED_PASSED_SCREEN\"",
- "\"ALLOWED_FAILED_SCREEN\"",
- "\"ALLOWED\"",
- "\"PROHIB_NOT_SCREENED\"",
- "\"PROHIB_PASSED_SCREEN\"",
- "\"PROHIB_FAILED_SCREEN\"",
- "\"PROHIB\""
- ],
- "optional": true,
- "field": "callingpres",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "deny",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "permit",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "secret",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "md5secret",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "remotesecret",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "transport",
- "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"rfc2833\"",
- "\"info\"",
- "\"shortinfo\"",
- "\"inband\"",
- "\"auto\""
- ],
- "optional": true,
- "field": "dtmfmode",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\"",
- "\"nonat\"",
- "\"update\"",
- "\"outgoing\""
- ],
- "optional": true,
- "field": "directmedia",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "directrtpsetup",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "directmediapermit",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "directmediadeny",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "nat",
- "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "callgroup",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "namedcallgroup",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "pickupgroup",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "namedpickupgroup",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "language",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "tonezone",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": false,
- "field": "disallow",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": false,
- "field": "allow",
- "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "gsm"]</p>"
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "autoframing",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "insecure",
- "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "trustrpid",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "trust_id_outbound",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\"",
- "\"never\""
- ],
- "optional": true,
- "field": "progressinband",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "promiscredir",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "useclientcode",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "accountcode",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "setvar",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "callerid",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "amaflags",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "callcounter",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "busylevel",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "allowoverlap",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "allowsubscribe",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "allowtransfer",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "ignoresdpversion",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "subscribecontext",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "template",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\"",
- "\"always\""
- ],
- "optional": true,
- "field": "videosupport",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "maxcallbitrate",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "rfc2833compensate",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "mailbox",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"accept\"",
- "\"refuse\"",
- "\"originate\""
- ],
- "optional": true,
- "field": "session_timers",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "session_expires",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "session_minse",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"uac\"",
- "\"uas\""
- ],
- "optional": true,
- "field": "session_refresher",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "t38pt_usertpsource",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "regexten",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "fromdomain",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "fromuser",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "qualify",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "keepalive",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "defaultip",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "defaultuser",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "rtptimeout",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "rtpholdtimeout",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "rtpkeepalive",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "sendrpid",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "outboundproxy",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "callbackextension",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "timert1",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "timerb",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "qualifyfreq",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "contactpermit",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "contactdeny",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "contactacl",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "unsolicited_mailbox",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "use_q850_reason",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "maxforwards",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "encryption",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "avpf",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "force_avp",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "icesupport",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "dtlsenable",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\"",
- "\"fingerprint\"",
- "\"certificate\""
- ],
- "optional": true,
- "field": "dtlsverify",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "dtlsrekey",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "dtlscertfile",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "dtlsprivatekey",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "dtlscipher",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "dtlscafile",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "dtlscapath",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"active\"",
- "\"passive\"",
- "\"actpass\""
- ],
- "optional": true,
- "field": "dtlssetup",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "dtlsfingerprint",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "usereqphone",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "recordonfeature",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "recordofffeature",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "call_limit",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "registertrying",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "subscribemwi",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "vmexten",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "mohinterpret",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "mohsuggest",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "parkinglot",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\"",
- "\"nonat\"",
- "\"update\"",
- "\"update,nonat\""
- ],
- "optional": true,
- "field": "canreinvite",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "loginInPause",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "resetPasswordToken",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "resetPasswordExpires",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "showWebBar",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Text",
- "optional": true,
- "field": "permissions",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "phoneBarUnconditionalNumber",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "phoneBarNoReplyNumber",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "phoneBarBusyNumber",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarUnconditional",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarNoReply",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarBusy",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarDnd",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarUnansweredCallBadge",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarEnableDtmfTone",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "phoneBarAutoAnswerDelay",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "extensionMonitor",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "crudPermissions",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "rtcp_mux",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "allowmessenger",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "phoneBarOutboundProxy",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "passwordResetAt",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarEnableJaws",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarEnableScreenRecordingByAgent",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Virtual",
- "optional": true,
- "field": "phoneBarEnableVideoRecording",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarEnableAutomaticScreenRecording",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarPrefixRequired",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "hotdesk",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "interface",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "privacyEnabled",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "apiKeyNonce",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "apiKeyIat",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "screenrecording",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "blocked",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "blockedAt",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "loginAttempts",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "disabled",
- "description": ""
- }
- ]
- }
- },
"description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
"filename": "server/api/user/index.js",
},
{
"type": "get",
- "url": "/api/users/{id}/square_projects",
- "title": "GetSquareProjects",
+ "url": "/api/users/{id}/teams",
+ "title": "GetTeams",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
+ "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
"type": "json"
}
],
- "name": "GetSquareProjects",
+ "name": "GetTeams",
"group": "Users",
"description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
},
{
"type": "get",
- "url": "/api/users/{id}/teams",
- "title": "GetTeams",
+ "url": "/api/users",
+ "title": "Gets a list of Users",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
+ "content": "curl https://{domain}/api/users -v -u {name}:{password}",
"type": "json"
}
],
- "name": "GetTeams",
+ "name": "GetUsers",
+ "group": "Users",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/{id}/queues_rt",
+ "title": "GetVoiceQueuesRt",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetVoiceQueuesRt",
"group": "Users",
"description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
},
{
"type": "get",
- "url": "/api/users",
- "title": "Gets a list of Users",
+ "url": "/api/users/{id}/whatsapp_accounts",
+ "title": "GetWhatsappAccounts",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/users -v -u {name}:{password}",
+ "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
"type": "json"
}
],
- "name": "GetUsers",
+ "name": "GetWhatsappAccounts",
"group": "Users",
- "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
"filename": "server/api/user/index.js",
"groupTitle": "Users"
},
{
"type": "get",
- "url": "/api/users/{id}/queues_rt",
- "title": "GetVoiceQueuesRt",
+ "url": "/api/users/{id}/whatsapp/interactions",
+ "title": "GetWhatsappInteractions",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
+ "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
"type": "json"
}
],
- "name": "GetVoiceQueuesRt",
+ "name": "GetWhatsappInteractions",
"group": "Users",
"description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
},
{
"type": "delete",
- "url": "/api/users/{id}/square_projects",
- "title": "Removes a Square Project from a user",
+ "url": "/api/users/{id}/teams",
+ "title": "Removes teams from an agent",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
"type": "json"
}
],
- "name": "RemoveSquareProjects",
+ "name": "RemoveTeams",
"group": "Users",
"description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
},
{
"type": "delete",
- "url": "/api/users/{id}/teams",
- "title": "Removes teams from an agent",
+ "url": "/api/users/{id}/whatsapp_accounts",
+ "title": "Removes a Whatsapp Account from a user",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
"type": "json"
}
],
- "name": "RemoveTeams",
+ "name": "RemoveWhatsappAccounts",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "delete",
+ "url": "/api/users/{id}/whatsapp_interactions",
+ "title": "Removes Whatsapp interactions from an agent",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveWhatsappInteractions",
"group": "Users",
"description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
"groupTitle": "Users"
},
{
+ "type": "post",
+ "url": "/api/users/create_many",
+ "title": "Create Users",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "bulkCreate",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
"type": "get",
"url": "/api/users/{id}/avatar",
"title": "Get avatar",
"groupTitle": "Users"
},
{
+ "type": "get",
+ "url": "/api/users/{id}/open_tabs",
+ "title": "Get interactions opened tabs",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getOpenTabs",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
+ "url": "/api/users/presence",
+ "title": "Gets agent presence",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/presence -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getPresence",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "post",
+ "url": "/api/users/{id}/messengerSoundNotification",
+ "title": "MessengerSoundNotification",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/messengerSoundNotification -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "messengerSoundNotification",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
"type": "put",
"url": "/api/users/{id}",
"title": "Update an existing User",
"groupTitle": "Voice_Call_Reports"
},
{
+ "type": "put",
+ "url": "/api/voice/calls/reports/{id}",
+ "title": "Update a single cdr",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDisposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "update",
+ "group": "Voice_Call_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceCallReport/index.js",
+ "groupTitle": "Voice_Call_Reports"
+ },
+ {
"type": "post",
"url": "/api/voice/chanspy",
"title": "Creates a new ChanSpy",
{
"group": "Body",
"type": "String",
- "optional": false,
+ "optional": true,
"field": "stamp",
"description": ""
}
},
{
"type": "post",
+ "url": "/api/voice/prefixes/{id}/teams",
+ "title": "Add teams to voice prefix",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddTeams",
+ "group": "Voice_Prefix",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voicePrefix/index.js",
+ "groupTitle": "Voice_Prefix"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/prefixes/{id}/teams",
+ "title": "Gets voice prefix team",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetTeams",
+ "group": "Voice_Prefix",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voicePrefix/index.js",
+ "groupTitle": "Voice_Prefix"
+ },
+ {
+ "type": "post",
"url": "/api/voice/prefixes/{id}/users",
"title": "Add agents to a prefix",
"examples": [
"group": "Body",
"type": "Integer",
"optional": true,
+ "field": "dialNoSuchNumberMaxRetry",
+ "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialNoSuchNumberRetryFrequency",
+ "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialDropMaxRetry",
+ "description": "<p>#Drop Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialDropRetryFrequency",
+ "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAbandonedMaxRetry",
+ "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAbandonedRetryFrequency",
+ "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialMachineMaxRetry",
+ "description": "<p>#Machine Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialMachineRetryFrequency",
+ "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAgentRejectMaxRetry",
+ "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "dialAgentRejectRetryFrequency",
+ "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
"field": "mandatoryDispositionPauseId",
"description": "<p>Status to put when mandatory disposition is enabled</p>"
},
"optional": true,
"field": "dialPredictiveIntervalMinThreshold",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "dialPreviewAutoRecallMe",
+ "description": ""
}
]
}
"group": "Body",
"type": "String",
"optional": true,
+ "field": "userSecondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "userThirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "location",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transcribeName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transcribeStatus",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "fileUri",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "fileText",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "failureReason",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "sentiment",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Float",
+ "optional": true,
+ "field": "sPositive",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Float",
+ "optional": true,
+ "field": "sNegative",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Float",
+ "optional": true,
+ "field": "sNeutral",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Float",
+ "optional": true,
+ "field": "sMixed",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "tempSentiment",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "createdAt",
"description": ""
},
"groupTitle": "Voice_Recordings"
},
{
+ "type": "post",
+ "url": "/api/voice/recordings/{id}/transcribe",
+ "title": "Run Transcribe Recording",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "transcribe",
+ "group": "Voice_Recordings",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceRecording/index.js",
+ "groupTitle": "Voice_Recordings"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/recordings/{id}/transcribe",
+ "title": "Run Transcribe Recording",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "transcribe",
+ "group": "Voice_Recordings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceRecording/index.js",
+ "groupTitle": "Voice_Recordings"
+ },
+ {
"type": "put",
"url": "/api/voice/recordings/{id}",
"title": "Update an existing Recording",
},
{
"type": "get",
+ "url": "/api/voice/transfers/reports/describe",
+ "title": "Gets table info about Transfer Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeTransfer_Reports",
+ "group": "Voice_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceTransferReport/index.js",
+ "groupTitle": "Voice_Transfer_Reports"
+ },
+ {
+ "type": "get",
"url": "/api/voice/transfers/reports",
"title": "Gets a list of Transfer Reports",
"examples": [
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "serverUrl",
"description": ""
},
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
},
{
"type": "post",
+ "url": "/api/webbar/answer",
+ "title": "answer webrtc call",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Web_Bar_answer",
+ "group": "WebBar",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "sessionId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "number",
+ "optional": false,
+ "field": "userId",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/webbar/index.js",
+ "groupTitle": "WebBar"
+ },
+ {
+ "type": "post",
+ "url": "/api/webbar/calls",
+ "title": "webrtc call list",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Web_Bar_calls",
+ "group": "WebBar",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "number",
+ "optional": false,
+ "field": "userId",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/webbar/index.js",
+ "groupTitle": "WebBar"
+ },
+ {
+ "type": "post",
+ "url": "/api/webbar/hangup",
+ "title": "hangup webrtc call",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Web_Bar_hangup",
+ "group": "WebBar",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "sessionId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "number",
+ "optional": false,
+ "field": "userId",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/webbar/index.js",
+ "groupTitle": "WebBar"
+ },
+ {
+ "type": "post",
+ "url": "/api/webbar/hold",
+ "title": "hold webrtc call",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Web_Bar_hold",
+ "group": "WebBar",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "sessionId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "number",
+ "optional": false,
+ "field": "userId",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/webbar/index.js",
+ "groupTitle": "WebBar"
+ },
+ {
+ "type": "post",
+ "url": "/api/webbar/unhold",
+ "title": "unhold webrtc call",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Web_Bar_hold",
+ "group": "WebBar",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "sessionId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "number",
+ "optional": false,
+ "field": "userId",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/webbar/index.js",
+ "groupTitle": "WebBar"
+ },
+ {
+ "type": "post",
+ "url": "/api/webbar/originate",
+ "title": "Originate new webrtc call",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Web_Bar_originate",
+ "group": "WebBar",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "callNumber",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "number",
+ "optional": false,
+ "field": "userId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "callerId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "callbackUrl",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/webbar/index.js",
+ "groupTitle": "WebBar"
+ },
+ {
+ "type": "post",
+ "url": "/api/webbar/transfer",
+ "title": "blind transfer webrtc call",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Web_Bar_transfer",
+ "group": "WebBar",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "number",
+ "optional": false,
+ "field": "userId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "string",
+ "optional": false,
+ "field": "sessionId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "string",
+ "optional": false,
+ "field": "transferNumber",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/webbar/index.js",
+ "groupTitle": "WebBar"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/accounts/{id}/users",
+ "title": "Add agents to a whatsapp account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddAgents",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/accounts",
+ "title": "Creates a new Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateAccounts",
+ "group": "Whatsapp_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "remote",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "token",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "phone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"twilio\""
+ ],
+ "optional": true,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "accountSid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "authToken",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "notificationTemplate",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "notificationSound",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "notificationShake",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "waitForTheAssignedAgent",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "waitForTheAssignedQueue",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "queueTransfer",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "queueTransferTimeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "agentTransfer",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "agentTransferTimeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "mandatoryDispositionPauseId",
+ "description": "<p>Status to put when mandatory disposition is enabled</p>"
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "mandatoryDisposition",
+ "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/accounts/{id}",
+ "title": "Deletes a Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteAccounts",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/accounts/describe",
+ "title": "Gets table info about Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeAccounts",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/accounts",
+ "title": "Gets a list of Accounts",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetAccounts",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/accounts/{id}/users",
+ "title": "Gets agents from whatsapp account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetAgents",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/accounts/{id}/users",
+ "title": "Removes agents from a whatsapp account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAgents",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/accounts/{id}/canned_answers",
+ "title": "Removes canned answers from account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAnswers",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/accounts/{id}/dispositions",
+ "title": "Removes dispositions from account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveDispositions",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/accounts/{id}",
+ "title": "Gets a single Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowAccounts",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/whatsapp/messages/{id}/accept",
+ "title": "Accepts message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "acceptMessage",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappMessage/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/accounts/{id}/canned_answers",
+ "title": "Creates new canned answer",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "addAnswer",
+ "group": "Whatsapp_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "key",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "value",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Virtual",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/accounts/{id}/applications",
+ "title": "Creates new applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addApplications",
+ "group": "Whatsapp_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "priority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "app",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "appdata",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "interval",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/accounts/{id}/dispositions",
+ "title": "Creates new disposition",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addDisposition",
+ "group": "Whatsapp_Accounts",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/accounts/{id}/canned_answers",
+ "title": "Gets account canned answers",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getAnswers",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/accounts/{id}/applications",
+ "title": "Gets account applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getApplications",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/accounts/{id}/dispositions",
+ "title": "Gets account dispositions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDispositions",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/accounts/{id}/notify",
+ "title": "Notify new message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "notify",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion 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>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/whatsapp/messages/{id}/reject",
+ "title": "Rejects message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
+ "type": "json"
+ }
+ ],
+ "name": "rejectMessage",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappMessage/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/accounts/{id}/send",
+ "title": "Send new whatsapp message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "sendWhatsapp",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/messages/{id}/status",
+ "title": "Receive message status",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "statusMessage",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappMessage/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "put",
+ "url": "/api/whatsapp/accounts/{id}",
+ "title": "Update an existing Account",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateAccounts",
+ "group": "Whatsapp_Accounts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappAccount/index.js",
+ "groupTitle": "Whatsapp_Accounts"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/applications",
+ "title": "Creates a new Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateApplications",
+ "group": "Whatsapp_Applications",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": false,
+ "field": "priority",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "app",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "appdata",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "interval",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappApplication/index.js",
+ "groupTitle": "Whatsapp_Applications"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/applications/{id}",
+ "title": "Deletes a Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteApplications",
+ "group": "Whatsapp_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappApplication/index.js",
+ "groupTitle": "Whatsapp_Applications"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/applications",
+ "title": "Gets a list of Applications",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetApplications",
+ "group": "Whatsapp_Applications",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappApplication/index.js",
+ "groupTitle": "Whatsapp_Applications"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/applications/{id}",
+ "title": "Gets a single Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowApplications",
+ "group": "Whatsapp_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappApplication/index.js",
+ "groupTitle": "Whatsapp_Applications"
+ },
+ {
+ "type": "put",
+ "url": "/api/whatsapp/applications/{id}",
+ "title": "Update an existing Application",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateApplications",
+ "group": "Whatsapp_Applications",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappApplication/index.js",
+ "groupTitle": "Whatsapp_Applications"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/interactions/{id}/tags",
+ "title": "Add tags to the interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddTags",
+ "group": "Whatsapp_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/interactions",
+ "title": "Creates a new Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateInteractions",
+ "group": "Whatsapp_Interactions",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "closed",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "closedAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "disposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "note",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "phone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "read1stAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "firstMsgDirection",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "lastMsgAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "lastMsgDirection",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "autoreplyExecuted",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/interactions/{id}",
+ "title": "Deletes a Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteInteractions",
+ "group": "Whatsapp_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/interactions/describe",
+ "title": "Gets table info about Interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeInteractions",
+ "group": "Whatsapp_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/interactions",
+ "title": "Gets a list of Interactions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetInteractions",
+ "group": "Whatsapp_Interactions",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/interactions/{id}/tags",
+ "title": "Removes tags from interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveTags",
+ "group": "Whatsapp_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/interactions/{id}",
+ "title": "Gets a single Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowInteractions",
+ "group": "Whatsapp_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/interactions/{id}/messages",
+ "title": "Creates new messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "addMessage",
+ "group": "Whatsapp_Interactions",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "body",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "read",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "direction",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "messageId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "phone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "readAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "secret",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/interactions/{id}/download",
+ "title": "Gets interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "download",
+ "group": "Whatsapp_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/interactions/{id}/messages",
+ "title": "Gets interaction messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getMessages",
+ "group": "Whatsapp_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "put",
+ "url": "/api/whatsapp/interactions/{id}",
+ "title": "Update an existing Interaction",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateInteractions",
+ "group": "Whatsapp_Interactions",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappInteraction/index.js",
+ "groupTitle": "Whatsapp_Interactions"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/messages",
+ "title": "Creates a new Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateMessages",
+ "group": "Whatsapp_Messages",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": false,
+ "field": "body",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "read",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"in\"",
+ "\"out\""
+ ],
+ "optional": false,
+ "field": "direction",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "messageId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "phone",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "readAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "secret",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappMessage/index.js",
+ "groupTitle": "Whatsapp_Messages"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/messages/{id}",
+ "title": "Deletes a Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteMessages",
+ "group": "Whatsapp_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappMessage/index.js",
+ "groupTitle": "Whatsapp_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/messages/describe",
+ "title": "Gets table info about Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeMessages",
+ "group": "Whatsapp_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappMessage/index.js",
+ "groupTitle": "Whatsapp_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/messages",
+ "title": "Gets a list of Messages",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMessages",
+ "group": "Whatsapp_Messages",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappMessage/index.js",
+ "groupTitle": "Whatsapp_Messages"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/messages/{id}",
+ "title": "Gets a single Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowMessages",
+ "group": "Whatsapp_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappMessage/index.js",
+ "groupTitle": "Whatsapp_Messages"
+ },
+ {
+ "type": "put",
+ "url": "/api/whatsapp/messages/{id}",
+ "title": "Update an existing Message",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateMessages",
+ "group": "Whatsapp_Messages",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappMessage/index.js",
+ "groupTitle": "Whatsapp_Messages"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/reports/queue",
+ "title": "Creates a new Whatsapp Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateWhatsapp_Queue_Reports",
+ "group": "Whatsapp_Queue_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "from",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "joinAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "leaveAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "acceptAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "exitAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "reason",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueueReport/index.js",
+ "groupTitle": "Whatsapp_Queue_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/reports/queue/{id}",
+ "title": "Deletes a Whatsapp Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteWhatsapp_Queue_Reports",
+ "group": "Whatsapp_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueueReport/index.js",
+ "groupTitle": "Whatsapp_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/reports/queue/describe",
+ "title": "Gets table info about Whatsapp Queue Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeWhatsapp_Queue_Reports",
+ "group": "Whatsapp_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueueReport/index.js",
+ "groupTitle": "Whatsapp_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/reports/queue",
+ "title": "Gets a list of Whatsapp Queue Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetWhatsapp_Queue_Reports",
+ "group": "Whatsapp_Queue_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueueReport/index.js",
+ "groupTitle": "Whatsapp_Queue_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/reports/queue/{id}",
+ "title": "Gets a single Whatsapp Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowWhatsapp_Queue_Reports",
+ "group": "Whatsapp_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueueReport/index.js",
+ "groupTitle": "Whatsapp_Queue_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/whatsapp/reports/queue/{id}",
+ "title": "Update an existing Whatsapp Queue Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateWhatsapp_Queue_Reports",
+ "group": "Whatsapp_Queue_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueueReport/index.js",
+ "groupTitle": "Whatsapp_Queue_Reports"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/queues/{id}/users",
+ "title": "Add agents to a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddAgents",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/queues/{id}/teams",
+ "title": "Add teams to a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "AddTeams",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/queues",
+ "title": "Creates a new Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "CreateQueues",
+ "group": "Whatsapp_Queues",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Integer",
+ "optional": true,
+ "field": "timeout",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"rrmemory\"",
+ "\"beepall\"",
+ "\"roundrobin\""
+ ],
+ "optional": true,
+ "field": "strategy",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/queues/{id}",
+ "title": "Deletes a Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteQueues",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/queues/describe",
+ "title": "Gets table info about Queues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeQueues",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/queues/{id}/users",
+ "title": "Gets queue agents",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "GetAgents",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/queues/{id}/members",
+ "title": "GetMembers",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/queues/{id}/members -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetMembers",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/queues",
+ "title": "Gets a list of Queues",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetQueues",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/queues/{id}/teams",
+ "title": "Gets queues list",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetTeams",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/queues/{id}/users",
+ "title": "Removes agents from a queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveAgents",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/queues/{id}",
+ "title": "Gets a single Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowQueues",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "put",
+ "url": "/api/whatsapp/queues/{id}",
+ "title": "Update an existing Queue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateQueues",
+ "group": "Whatsapp_Queues",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappQueue/index.js",
+ "groupTitle": "Whatsapp_Queues"
+ },
+ {
+ "type": "post",
+ "url": "/api/whatsapp/reports/transfer",
+ "title": "Creates a new Whatsapp Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "CreateWhatsapp_Transfer_Reports",
+ "group": "Whatsapp_Transfer_Reports",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "uniqueid",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"account\"",
+ "\"agent\"",
+ "\"queue\""
+ ],
+ "optional": false,
+ "field": "type",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "transferredAt",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappTransferReport/index.js",
+ "groupTitle": "Whatsapp_Transfer_Reports"
+ },
+ {
+ "type": "delete",
+ "url": "/api/whatsapp/reports/transfer/{id}",
+ "title": "Deletes a Whatsapp Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
+ "type": "json"
+ }
+ ],
+ "name": "DeleteWhatsapp_Transfer_Reports",
+ "group": "Whatsapp_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappTransferReport/index.js",
+ "groupTitle": "Whatsapp_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/reports/transfer/describe",
+ "title": "Gets table info about Whatsapp Transfer Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeWhatsapp_Transfer_Reports",
+ "group": "Whatsapp_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappTransferReport/index.js",
+ "groupTitle": "Whatsapp_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/reports/transfer",
+ "title": "Gets a list of Whatsapp Transfer Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "GetWhatsapp_Transfer_Reports",
+ "group": "Whatsapp_Transfer_Reports",
+ "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappTransferReport/index.js",
+ "groupTitle": "Whatsapp_Transfer_Reports"
+ },
+ {
+ "type": "get",
+ "url": "/api/whatsapp/reports/transfer/{id}",
+ "title": "Gets a single Whatsapp Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "ShowWhatsapp_Transfer_Reports",
+ "group": "Whatsapp_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappTransferReport/index.js",
+ "groupTitle": "Whatsapp_Transfer_Reports"
+ },
+ {
+ "type": "put",
+ "url": "/api/whatsapp/reports/transfer/{id}",
+ "title": "Update an existing Whatsapp Transfer Report",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "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",
+ "type": "json"
+ }
+ ],
+ "name": "updateWhatsapp_Transfer_Reports",
+ "group": "Whatsapp_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/whatsappTransferReport/index.js",
+ "groupTitle": "Whatsapp_Transfer_Reports"
+ },
+ {
+ "type": "post",
"url": "/api/integrations/zendesk/accounts",
"title": "Creates a new Zendesk Account",
"examples": [
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "serverUrl",
"description": ""
},
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "serverUrl",
"description": ""
},
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
git://repos.xcallymotion.com / motion2.git / blobdiff