X-Git-Url: http://repos.xcallymotion.com/?a=blobdiff_plain;f=apidoc%2Fapi_data.js;h=44c717d90293ef6798619a9bc4c2aa055a5f3d48;hb=5ce610d3f4c768865e05185aa062c8402f6dcea4;hp=e4a0eeb754c4de970f3e150d3a335c37bb7ac022;hpb=24271de0e5dd1b448821a50abace88b2fad818a2;p=motion2.git diff --git a/apidoc/api_data.js b/apidoc/api_data.js index e4a0eeb..44c717d 100644 --- a/apidoc/api_data.js +++ b/apidoc/api_data.js @@ -2295,6 +2295,13 @@ define({ "api": [ "optional": true, "field": "customerPort", "description": "" + }, + { + "group": "Body", + "type": "Text", + "optional": true, + "field": "vidaooSessionId", + "description": "" } ] } @@ -2413,6 +2420,24 @@ define({ "api": [ "groupTitle": "Chat_Interactions" }, { + "type": "put", + "url": "/api/chat/interactions/{id}/close", + "title": "Close Interaction", + "examples": [ + { + "title": "Example usage:", + "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST", + "type": "json" + } + ], + "name": "addMessage", + "group": "Chat_Interactions", + "description": "
Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "version": "0.0.0", + "filename": "server/api/chatInteraction/index.js", + "groupTitle": "Chat_Interactions" + }, + { "type": "post", "url": "/api/chat/interactions/{id}/messages", "title": "Creates new messages", @@ -2476,35 +2501,35 @@ define({ "api": [ "groupTitle": "Chat_Interactions" }, { - "type": "put", - "url": "/api/chat/interactions/{id}/close", - "title": "Close Interaction", + "type": "post", + "url": "/api/chat/interactions/{id}/attachment_upload", + "title": "Add attachment", "examples": [ { "title": "Example usage:", - "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST", + "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST", "type": "json" } ], - "name": "addMessage", + "name": "attachmentUpload", "group": "Chat_Interactions", - "description": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "description": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", "version": "0.0.0", "filename": "server/api/chatInteraction/index.js", "groupTitle": "Chat_Interactions" }, { "type": "post", - "url": "/api/chat/interactions/{id}/attachment_upload", - "title": "Add attachment", + "url": "/api/chat/interactions/{id}/vidaoo", + "title": "Create Vidaoo Session", "examples": [ { "title": "Example usage:", - "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST", + "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo -H 'Content-Type: application/json' -v -u {name}:{password} -X POST", "type": "json" } ], - "name": "attachmentUpload", + "name": "createVidaooSession", "group": "Chat_Interactions", "description": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", "version": "0.0.0", @@ -4300,6 +4325,20 @@ define({ "api": [ "optional": true, "field": "mandatoryDisposition", "description": "Enabled/disables mandatory dispo on a queue
" + }, + { + "group": "Body", + "type": "Boolean", + "optional": true, + "field": "vidaooEscalation", + "description": "" + }, + { + "group": "Body", + "type": "String", + "optional": true, + "field": "vidaooApiKey", + "description": "" } ] } @@ -4840,6 +4879,13 @@ define({ "api": [ "optional": true, "field": "customerPort", "description": "" + }, + { + "group": "Body", + "type": "Text", + "optional": true, + "field": "vidaooSessionId", + "description": "" } ] } @@ -5231,6 +5277,134 @@ define({ "api": [ }, { "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": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 204
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will always return paged results. Motion returns paging data in the Content-Range
header in the form start - end / total.
Upon success Motion will return a HTTP status code 200 OK
if the entire collection was returned otherwise it will return a HTTP status code 206
Partial Content.
Motion renders the resulting JSON representation in the response body.
To return only specific fields for a result set you can utilize the fields
parameter. This parameter accepts a comma-separated list.
A call returning only id
and name
for a result set would look like this.
GET /api/cloudProviders?fields=id,name
You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.
A call returning a result set for records with name
of john.doe
or jane.miller
.
GET /api/cloudProviders?name=john.doe,jane.miller
If you use the key filter
the result will be filtered by the value you specify.
GET /api/cloudProviders?filter=john
To sort a result set based on one or several fields you can utilize the sort
parameter. This parameters accepts a comma-separated list.
Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-
).
A call sorting a result by id
ascending and then name
descending would look like this.
GET /api/cloudProviders?sort=id,-name
Query results are always paged. Motion leverages the offset
and limit
parameters to facilitate this.
When the neither of these parameters are explicitly supplied the handler will assume the a default limit
of 100
.
offset
is a number indicating the start position in the result set you want to return.
limit
is a number indicating how many records past the start position you want returned.
A call with a result set starting at 5
and returning no more than 25
records would look like this.
GET /api/cloudProviders?offset=5&limit=25
If there were 50
records in total, the returned Content-Range
header would look like this.
Content-Range: 5-30/50
Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "version": "0.0.0", + "filename": "server/api/cloudProvider/index.js", + "groupTitle": "CloudProviders" + }, + { + "type": "post", "url": "/api/cm/companies", "title": "Creates a new Company", "examples": [ @@ -16760,6 +16934,24 @@ define({ "api": [ }, { "type": "post", + "url": "/api/notifications", + "title": "Send notification to user", + "examples": [ + { + "title": "Example usage:", + "content": "curl https://{domain}/api/notifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST", + "type": "json" + } + ], + "name": "Send", + "group": "Notifications", + "description": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "version": "0.0.0", + "filename": "server/api/notification/index.js", + "groupTitle": "Notifications" + }, + { + "type": "post", "url": "/api/openchannel/accounts/{id}/users", "title": "Add agents to a openchannel account", "examples": [ @@ -18744,37 +18936,37 @@ define({ "api": [ "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": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "description": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "description": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", "version": "0.0.0", "filename": "server/api/plugin/index.js", "groupTitle": "Plugins" @@ -19251,36 +19443,36 @@ define({ "api": [ }, { "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": "Motion will return a list of realtime voice queues parameters.
Upon success Motion will return a HTTP status code 200 OK
if the entire collection was returned.
Motion renders the resulting JSON representation in the response body.
", + "description": "Motion will return a list of realtime outbound parameters.
Upon success Motion will return a HTTP status code 200 OK
if the entire collection was returned.
Motion renders the resulting JSON representation in the response body.
", "version": "0.0.0", "filename": "server/api/rpc/index.js", "groupTitle": "RPC_Realtime" }, { "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": "Motion will return a list of realtime outbound parameters.
Upon success Motion will return a HTTP status code 200 OK
if the entire collection was returned.
Motion renders the resulting JSON representation in the response body.
", + "description": "Motion will return a list of realtime voice queues parameters.
Upon success Motion will return a HTTP status code 200 OK
if the entire collection was returned.
Motion renders the resulting JSON representation in the response body.
", "version": "0.0.0", "filename": "server/api/rpc/index.js", "groupTitle": "RPC_Realtime" @@ -22054,49 +22246,49 @@ define({ "api": [ "groupTitle": "Sms_Accounts" }, { - "type": "get", - "url": "/api/sms/accounts/{id}/status", - "title": "Receive message status as get request", + "type": "post", + "url": "/api/sms/messages/{id}/status", + "title": "Receive message status", "examples": [ { "title": "Example usage:", - "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET", + "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST", "type": "json" } ], "name": "statusMessage", "group": "Sms_Accounts", - "description": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "description": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", "version": "0.0.0", - "filename": "server/api/smsAccount/index.js", + "filename": "server/api/smsMessage/index.js", "groupTitle": "Sms_Accounts" }, { - "type": "post", + "type": "get", "url": "/api/sms/accounts/{id}/status", - "title": "Receive message status", + "title": "Receive message status as get request", "examples": [ { "title": "Example usage:", - "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST", + "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET", "type": "json" } ], "name": "statusMessage", "group": "Sms_Accounts", - "description": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "description": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", "version": "0.0.0", "filename": "server/api/smsAccount/index.js", "groupTitle": "Sms_Accounts" }, { "type": "post", - "url": "/api/sms/messages/{id}/status", + "url": "/api/sms/accounts/{id}/status", "title": "Receive message status", "examples": [ { "title": "Example usage:", - "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST", + "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST", "type": "json" } ], @@ -22104,7 +22296,7 @@ define({ "api": [ "group": "Sms_Accounts", "description": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", "version": "0.0.0", - "filename": "server/api/smsMessage/index.js", + "filename": "server/api/smsAccount/index.js", "groupTitle": "Sms_Accounts" }, { @@ -25049,7 +25241,7 @@ define({ "api": [ }, { "type": "get", - "url": "/api/system/process", + "url": "/api/system", "title": "Gets system information", "examples": [ { @@ -25067,7 +25259,7 @@ define({ "api": [ }, { "type": "get", - "url": "/api/system", + "url": "/api/system/process", "title": "Gets system information", "examples": [ { @@ -25366,12 +25558,12 @@ define({ "api": [ }, { "type": "delete", - "url": "/api/chat/queues/{id}/teams", + "url": "/api/mail/queues/{id}/teams", "title": "Remove teams from a queue", "examples": [ { "title": "Example usage:", - "content": "curl https://{domain}/api/chat/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" } ], @@ -25379,17 +25571,17 @@ define({ "api": [ "group": "Teams", "description": "Motion will return a HTTP status code 204
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", "version": "0.0.0", - "filename": "server/api/chatQueue/index.js", + "filename": "server/api/mailQueue/index.js", "groupTitle": "Teams" }, { "type": "delete", - "url": "/api/fax/queues/{id}/teams", + "url": "/api/openchannel/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/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE", "type": "json" } ], @@ -25397,17 +25589,17 @@ define({ "api": [ "group": "Teams", "description": "Motion will return a HTTP status code 204
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", "version": "0.0.0", - "filename": "server/api/faxQueue/index.js", + "filename": "server/api/openchannelQueue/index.js", "groupTitle": "Teams" }, { "type": "delete", - "url": "/api/openchannel/queues/{id}/teams", + "url": "/api/whatsapp/queues/{id}/teams", "title": "Remove teams from a queue", "examples": [ { "title": "Example usage:", - "content": "curl https://{domain}/api/openchannel/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" } ], @@ -25415,7 +25607,7 @@ define({ "api": [ "group": "Teams", "description": "Motion will return a HTTP status code 204
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", "version": "0.0.0", - "filename": "server/api/openchannelQueue/index.js", + "filename": "server/api/whatsappQueue/index.js", "groupTitle": "Teams" }, { @@ -25456,12 +25648,12 @@ define({ "api": [ }, { "type": "delete", - "url": "/api/mail/queues/{id}/teams", + "url": "/api/chat/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/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE", "type": "json" } ], @@ -25469,7 +25661,25 @@ define({ "api": [ "group": "Teams", "description": "Motion will return a HTTP status code 204
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", "version": "0.0.0", - "filename": "server/api/mailQueue/index.js", + "filename": "server/api/chatQueue/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": "Motion will return a HTTP status code 204
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "version": "0.0.0", + "filename": "server/api/faxQueue/index.js", "groupTitle": "Teams" }, { @@ -27829,6 +28039,42 @@ define({ "api": [ }, { "type": "post", + "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}/whatsapp_accounts -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST", + "type": "json" + } + ], + "name": "AddWhatsappAccounts", + "group": "Users", + "description": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "version": "0.0.0", + "filename": "server/api/user/index.js", + "groupTitle": "Users" + }, + { + "type": "post", + "url": "/api/users/{id}/whatsapp_interactions", + "title": "Add Whatsapp interaction tabs to an agent", + "examples": [ + { + "title": "Example usage:", + "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": "AddWhatsappInteractions", + "group": "Users", + "description": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "version": "0.0.0", + "filename": "server/api/user/index.js", + "groupTitle": "Users" + }, + { + "type": "post", "url": "/api/users/create_many", "title": "Creates many Users", "examples": [ @@ -28014,6 +28260,13 @@ define({ "api": [ "group": "Body", "type": "Boolean", "optional": true, + "field": "whatsappPause", + "description": "" + }, + { + "group": "Body", + "type": "Boolean", + "optional": true, "field": "openchannelPause", "description": "" }, @@ -28063,6 +28316,13 @@ define({ "api": [ "group": "Body", "type": "Integer", "optional": true, + "field": "whatsappCapacity", + "description": "" + }, + { + "group": "Body", + "type": "Integer", + "optional": true, "field": "openchannelCapacity", "description": "" }, @@ -29819,6 +30079,42 @@ define({ "api": [ "groupTitle": "Users" }, { + "type": "get", + "url": "/api/users/{id}/whatsapp_accounts", + "title": "GetWhatsappAccounts", + "examples": [ + { + "title": "Example usage:", + "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET", + "type": "json" + } + ], + "name": "GetWhatsappAccounts", + "group": "Users", + "description": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "version": "0.0.0", + "filename": "server/api/user/index.js", + "groupTitle": "Users" + }, + { + "type": "get", + "url": "/api/users/{id}/whatsapp/interactions", + "title": "GetWhatsappInteractions", + "examples": [ + { + "title": "Example usage:", + "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET", + "type": "json" + } + ], + "name": "GetWhatsappInteractions", + "group": "Users", + "description": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "version": "0.0.0", + "filename": "server/api/user/index.js", + "groupTitle": "Users" + }, + { "type": "post", "url": "/api/users/{id}/login", "title": "Login", @@ -30125,6 +30421,42 @@ define({ "api": [ "groupTitle": "Users" }, { + "type": "delete", + "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}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE", + "type": "json" + } + ], + "name": "RemoveWhatsappAccounts", + "group": "Users", + "description": "Motion will return a HTTP status code 204
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 204
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "version": "0.0.0", + "filename": "server/api/user/index.js", + "groupTitle": "Users" + }, + { "type": "get", "url": "/api/users/{id}", "title": "Gets a single User", @@ -33355,6 +33687,90 @@ define({ "api": [ }, { "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", @@ -33484,6 +33900,42 @@ define({ "api": [ "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "version": "0.0.0", + "filename": "server/api/voiceRecording/index.js", + "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": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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", @@ -34581,6 +35033,1822 @@ define({ "api": [ }, { "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": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "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": "Status to put when mandatory disposition is enabled
" + }, + { + "group": "Body", + "type": "Boolean", + "optional": true, + "field": "mandatoryDisposition", + "description": "Enabled/disables mandatory dispo on a queue
" + }, + { + "group": "Body", + "type": "String", + "optional": true, + "field": "description", + "description": "" + } + ] + } + }, + "description": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 204
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will always return paged results. Motion returns paging data in the Content-Range
header in the form start - end / total.
Upon success Motion will return a HTTP status code 200 OK
if the entire collection was returned otherwise it will return a HTTP status code 206
Partial Content.
Motion renders the resulting JSON representation in the response body.
To return only specific fields for a result set you can utilize the fields
parameter. This parameter accepts a comma-separated list.
A call returning only id
and name
for a result set would look like this.
GET /api/whatsapp/accounts?fields=id,name
You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.
A call returning a result set for records with name
of john.doe
or jane.miller
.
GET /api/whatsapp/accounts?name=john.doe,jane.miller
If you use the key filter
the result will be filtered by the value you specify.
GET /api/whatsapp/accounts?filter=john
To sort a result set based on one or several fields you can utilize the sort
parameter. This parameters accepts a comma-separated list.
Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-
).
A call sorting a result by id
ascending and then name
descending would look like this.
GET /api/whatsapp/accounts?sort=id,-name
Query results are always paged. Motion leverages the offset
and limit
parameters to facilitate this.
When the neither of these parameters are explicitly supplied the handler will assume the a default limit
of 100
.
offset
is a number indicating the start position in the result set you want to return.
limit
is a number indicating how many records past the start position you want returned.
A call with a result set starting at 5
and returning no more than 25
records would look like this.
GET /api/whatsapp/accounts?offset=5&limit=25
If there were 50
records in total, the returned Content-Range
header would look like this.
Content-Range: 5-30/50
Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 204
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 204
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 204
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "" + } + ] + } + }, + "description": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
This API is used to create a new whatsapp message to be sent to the system.
", + "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 204
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will always return paged results. Motion returns paging data in the Content-Range
header in the form start - end / total.
Upon success Motion will return a HTTP status code 200 OK
if the entire collection was returned otherwise it will return a HTTP status code 206
Partial Content.
Motion renders the resulting JSON representation in the response body.
To return only specific fields for a result set you can utilize the fields
parameter. This parameter accepts a comma-separated list.
A call returning only id
and name
for a result set would look like this.
GET /api/whatsapp/applications?fields=id,name
You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.
A call returning a result set for records with name
of john.doe
or jane.miller
.
GET /api/whatsapp/applications?name=john.doe,jane.miller
If you use the key filter
the result will be filtered by the value you specify.
GET /api/whatsapp/applications?filter=john
To sort a result set based on one or several fields you can utilize the sort
parameter. This parameters accepts a comma-separated list.
Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-
).
A call sorting a result by id
ascending and then name
descending would look like this.
GET /api/whatsapp/applications?sort=id,-name
Query results are always paged. Motion leverages the offset
and limit
parameters to facilitate this.
When the neither of these parameters are explicitly supplied the handler will assume the a default limit
of 100
.
offset
is a number indicating the start position in the result set you want to return.
limit
is a number indicating how many records past the start position you want returned.
A call with a result set starting at 5
and returning no more than 25
records would look like this.
GET /api/whatsapp/applications?offset=5&limit=25
If there were 50
records in total, the returned Content-Range
header would look like this.
Content-Range: 5-30/50
Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "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": "" + } + ] + } + }, + "description": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 204
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will always return paged results. Motion returns paging data in the Content-Range
header in the form start - end / total.
Upon success Motion will return a HTTP status code 200 OK
if the entire collection was returned otherwise it will return a HTTP status code 206
Partial Content.
Motion renders the resulting JSON representation in the response body.
To return only specific fields for a result set you can utilize the fields
parameter. This parameter accepts a comma-separated list.
A call returning only id
and name
for a result set would look like this.
GET /api/whatsapp/interactions?fields=id,name
You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.
A call returning a result set for records with name
of john.doe
or jane.miller
.
GET /api/whatsapp/interactions?name=john.doe,jane.miller
If you use the key filter
the result will be filtered by the value you specify.
GET /api/whatsapp/interactions?filter=john
To sort a result set based on one or several fields you can utilize the sort
parameter. This parameters accepts a comma-separated list.
Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-
).
A call sorting a result by id
ascending and then name
descending would look like this.
GET /api/whatsapp/interactions?sort=id,-name
Query results are always paged. Motion leverages the offset
and limit
parameters to facilitate this.
When the neither of these parameters are explicitly supplied the handler will assume the a default limit
of 100
.
offset
is a number indicating the start position in the result set you want to return.
limit
is a number indicating how many records past the start position you want returned.
A call with a result set starting at 5
and returning no more than 25
records would look like this.
GET /api/whatsapp/interactions?offset=5&limit=25
If there were 50
records in total, the returned Content-Range
header would look like this.
Content-Range: 5-30/50
Motion will return a HTTP status code 204
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "" + } + ] + } + }, + "description": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "" + } + ] + } + }, + "description": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 204
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will always return paged results. Motion returns paging data in the Content-Range
header in the form start - end / total.
Upon success Motion will return a HTTP status code 200 OK
if the entire collection was returned otherwise it will return a HTTP status code 206
Partial Content.
Motion renders the resulting JSON representation in the response body.
To return only specific fields for a result set you can utilize the fields
parameter. This parameter accepts a comma-separated list.
A call returning only id
and name
for a result set would look like this.
GET /api/whatsapp/messages?fields=id,name
You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.
A call returning a result set for records with name
of john.doe
or jane.miller
.
GET /api/whatsapp/messages?name=john.doe,jane.miller
If you use the key filter
the result will be filtered by the value you specify.
GET /api/whatsapp/messages?filter=john
To sort a result set based on one or several fields you can utilize the sort
parameter. This parameters accepts a comma-separated list.
Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-
).
A call sorting a result by id
ascending and then name
descending would look like this.
GET /api/whatsapp/messages?sort=id,-name
Query results are always paged. Motion leverages the offset
and limit
parameters to facilitate this.
When the neither of these parameters are explicitly supplied the handler will assume the a default limit
of 100
.
offset
is a number indicating the start position in the result set you want to return.
limit
is a number indicating how many records past the start position you want returned.
A call with a result set starting at 5
and returning no more than 25
records would look like this.
GET /api/whatsapp/messages?offset=5&limit=25
If there were 50
records in total, the returned Content-Range
header would look like this.
Content-Range: 5-30/50
Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 204
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will always return paged results. Motion returns paging data in the Content-Range
header in the form start - end / total.
Upon success Motion will return a HTTP status code 200 OK
if the entire collection was returned otherwise it will return a HTTP status code 206
Partial Content.
Motion renders the resulting JSON representation in the response body.
To return only specific fields for a result set you can utilize the fields
parameter. This parameter accepts a comma-separated list.
A call returning only id
and name
for a result set would look like this.
GET /api/whatsapp/reports/queue?fields=id,name
You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.
A call returning a result set for records with name
of john.doe
or jane.miller
.
GET /api/whatsapp/reports/queue?name=john.doe,jane.miller
If you use the key filter
the result will be filtered by the value you specify.
GET /api/whatsapp/reports/queue?filter=john
To sort a result set based on one or several fields you can utilize the sort
parameter. This parameters accepts a comma-separated list.
Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-
).
A call sorting a result by id
ascending and then name
descending would look like this.
GET /api/whatsapp/reports/queue?sort=id,-name
Query results are always paged. Motion leverages the offset
and limit
parameters to facilitate this.
When the neither of these parameters are explicitly supplied the handler will assume the a default limit
of 100
.
offset
is a number indicating the start position in the result set you want to return.
limit
is a number indicating how many records past the start position you want returned.
A call with a result set starting at 5
and returning no more than 25
records would look like this.
GET /api/whatsapp/reports/queue?offset=5&limit=25
If there were 50
records in total, the returned Content-Range
header would look like this.
Content-Range: 5-30/50
Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 204
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will always return paged results. Motion returns paging data in the Content-Range
header in the form start - end / total.
Upon success Motion will return a HTTP status code 200 OK
if the entire collection was returned otherwise it will return a HTTP status code 206
Partial Content.
Motion renders the resulting JSON representation in the response body.
To return only specific fields for a result set you can utilize the fields
parameter. This parameter accepts a comma-separated list.
A call returning only id
and name
for a result set would look like this.
GET /api/whatsapp/queues?fields=id,name
You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.
A call returning a result set for records with name
of john.doe
or jane.miller
.
GET /api/whatsapp/queues?name=john.doe,jane.miller
If you use the key filter
the result will be filtered by the value you specify.
GET /api/whatsapp/queues?filter=john
To sort a result set based on one or several fields you can utilize the sort
parameter. This parameters accepts a comma-separated list.
Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-
).
A call sorting a result by id
ascending and then name
descending would look like this.
GET /api/whatsapp/queues?sort=id,-name
Query results are always paged. Motion leverages the offset
and limit
parameters to facilitate this.
When the neither of these parameters are explicitly supplied the handler will assume the a default limit
of 100
.
offset
is a number indicating the start position in the result set you want to return.
limit
is a number indicating how many records past the start position you want returned.
A call with a result set starting at 5
and returning no more than 25
records would look like this.
GET /api/whatsapp/queues?offset=5&limit=25
If there were 50
records in total, the returned Content-Range
header would look like this.
Content-Range: 5-30/50
Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 204
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 201
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 204
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will always return paged results. Motion returns paging data in the Content-Range
header in the form start - end / total.
Upon success Motion will return a HTTP status code 200 OK
if the entire collection was returned otherwise it will return a HTTP status code 206
Partial Content.
Motion renders the resulting JSON representation in the response body.
To return only specific fields for a result set you can utilize the fields
parameter. This parameter accepts a comma-separated list.
A call returning only id
and name
for a result set would look like this.
GET /api/whatsapp/reports/transfer?fields=id,name
You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.
A call returning a result set for records with name
of john.doe
or jane.miller
.
GET /api/whatsapp/reports/transfer?name=john.doe,jane.miller
If you use the key filter
the result will be filtered by the value you specify.
GET /api/whatsapp/reports/transfer?filter=john
To sort a result set based on one or several fields you can utilize the sort
parameter. This parameters accepts a comma-separated list.
Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (-
).
A call sorting a result by id
ascending and then name
descending would look like this.
GET /api/whatsapp/reports/transfer?sort=id,-name
Query results are always paged. Motion leverages the offset
and limit
parameters to facilitate this.
When the neither of these parameters are explicitly supplied the handler will assume the a default limit
of 100
.
offset
is a number indicating the start position in the result set you want to return.
limit
is a number indicating how many records past the start position you want returned.
A call with a result set starting at 5
and returning no more than 25
records would look like this.
GET /api/whatsapp/reports/transfer?offset=5&limit=25
If there were 50
records in total, the returned Content-Range
header would look like this.
Content-Range: 5-30/50
Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": "Motion will return a HTTP status code 200
upon success. Motion return a HTTP status code 404
if the corresponding record could not be located.
Motion renders the resulting JSON representation in the response body.
", + "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": [