},
{
"type": "post",
- "url": "/api/auth/google",
+ "url": "/api/auth/local",
"title": "Creates a new User token",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
"type": "json"
}
],
},
"description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
- "filename": "server/api/authGoogle/index.js",
+ "filename": "server/api/authLocal/index.js",
"groupTitle": "Authentication"
},
{
"type": "post",
- "url": "/api/auth/local",
+ "url": "/api/auth/google",
"title": "Creates a new User token",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
"type": "json"
}
],
},
"description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
- "filename": "server/api/authLocal/index.js",
+ "filename": "server/api/authGoogle/index.js",
"groupTitle": "Authentication"
},
{
"group": "Body",
"type": "String",
"optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "note",
"description": ""
},
"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": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
- "version": "0.0.0",
- "filename": "server/api/chatInteraction/index.js",
- "groupTitle": "Chat_Interactions"
- },
- {
"type": "post",
"url": "/api/chat/interactions/{id}/messages",
"title": "Creates new messages",
"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": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatInteraction/index.js",
+ "groupTitle": "Chat_Interactions"
+ },
+ {
"type": "post",
"url": "/api/chat/interactions/{id}/attachment_upload",
"title": "Add attachment",
"optional": false,
"field": "name",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
}
]
}
"group": "Body",
"type": "String",
"optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "note",
"description": ""
},
"optional": false,
"field": "name",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
}
]
}
"optional": false,
"field": "name",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
}
]
}
"optional": false,
"field": "name",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
}
]
}
"group": "Body",
"type": "String",
"optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "note",
"description": ""
},
"group": "Body",
"type": "String",
"optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "note",
"description": ""
},
"optional": false,
"field": "name",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
}
]
}
"group": "Body",
"type": "String",
"optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "note",
"description": ""
},
"group": "Body",
"type": "String",
"optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "note",
"description": ""
},
"optional": false,
"field": "name",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
}
]
}
"group": "Body",
"type": "String",
"optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "note",
"description": ""
},
"groupTitle": "Plugins"
},
{
- "type": "get",
+ "type": "post",
"url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
"title": "Redirect a plugin request to the specified path",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
+ "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
"type": "json"
}
],
"name": "webhookPlugin",
"group": "Plugins",
- "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
"filename": "server/api/plugin/index.js",
"groupTitle": "Plugins"
},
{
- "type": "post",
+ "type": "get",
"url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
"title": "Redirect a plugin request to the specified path",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
+ "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
"type": "json"
}
],
"name": "webhookPlugin",
"group": "Plugins",
- "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
"filename": "server/api/plugin/index.js",
"groupTitle": "Plugins"
},
{
"type": "get",
+ "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
+ "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "openchannelQueuesIdWaitingInteractions",
+ "group": "RPC_Realtime",
+ "description": "<p>Motion will return a list of realtime waiting openchannel queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
"url": "/api/rpc/openchannel/queues/waitinginteractions",
"title": "Gets a list of openchannelQueuesWaitingInteractions",
"examples": [
"optional": false,
"field": "name",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
}
]
}
"groupTitle": "Sms_Accounts"
},
{
- "type": "get",
+ "type": "post",
"url": "/api/sms/accounts/{id}/status",
- "title": "Receive message status as get request",
+ "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/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
"type": "json"
}
],
"name": "statusMessage",
"group": "Sms_Accounts",
- "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
"filename": "server/api/smsAccount/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": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
"filename": "server/api/smsAccount/index.js",
"groupTitle": "Sms_Accounts"
"group": "Body",
"type": "String",
"optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "note",
"description": ""
},
},
{
"type": "get",
- "url": "/api/system",
+ "url": "/api/system/process",
"title": "Gets system information",
"examples": [
{
},
{
"type": "get",
- "url": "/api/system/process",
+ "url": "/api/system",
"title": "Gets system information",
"examples": [
{
},
{
"type": "delete",
- "url": "/api/whatsapp/queues/{id}/teams",
+ "url": "/api/voice/queues/{id}/teams",
"title": "Remove teams from a queue",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
+ "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
"type": "json"
}
],
"group": "Teams",
"description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
- "filename": "server/api/whatsappQueue/index.js",
+ "filename": "server/api/voiceQueue/index.js",
"groupTitle": "Teams"
},
{
},
{
"type": "delete",
- "url": "/api/voice/queues/{id}/teams",
+ "url": "/api/whatsapp/queues/{id}/teams",
"title": "Remove teams from a queue",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
+ "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
"type": "json"
}
],
"group": "Teams",
"description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
- "filename": "server/api/voiceQueue/index.js",
+ "filename": "server/api/whatsappQueue/index.js",
"groupTitle": "Teams"
},
{
"groupTitle": "Users"
},
{
- "type": "post",
- "url": "/api/users/create_many",
- "title": "Creates many Users",
- "examples": [
- {
- "title": "Example usage:",
- "content": "curl https://{domain}/api/users/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
- "type": "json"
- }
- ],
- "name": "BulkCreateUsers",
- "group": "Users",
- "parameter": {
- "fields": {
- "Body": [
- {
- "group": "Body",
- "type": "String",
- "optional": false,
- "field": "name",
- "description": "<p>The name of the user</p>"
- },
- {
- "group": "Body",
- "type": "String",
- "optional": false,
- "field": "fullname",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "alias",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": false,
- "field": "email",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"admin\"",
- "\"user\"",
- "\"agent\"",
- "\"telephone\""
- ],
- "optional": false,
- "field": "role",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": false,
- "field": "password",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "provider",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": false,
- "field": "internal",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "salt",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "phone",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "mobile",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "address",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "zipcode",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "userpic",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "city",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "country",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "online",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "lastLoginAt",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "voicePause",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "chatPause",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "mailPause",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "faxPause",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "smsPause",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "whatsappPause",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "openchannelPause",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "pauseType",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "lastPauseAt",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "chatCapacity",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "mailCapacity",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "faxCapacity",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "smsCapacity",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "whatsappCapacity",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "openchannelCapacity",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarAutoAnswer",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarEnableSettings",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "phoneBarListenPort",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "phoneBarExpires",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarRemoteControl",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "phoneBarRemoteControlPort",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarEnableRecording",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarRingInUse",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "chanspy",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "description",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "host",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "ipaddr",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "port",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "regseconds",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "fullcontact",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "regserver",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "useragent",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "lastms",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"friend\"",
- "\"user\"",
- "\"peer\""
- ],
- "optional": true,
- "field": "type",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "context",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"ALLOWED_NOT_SCREENED\"",
- "\"ALLOWED_PASSED_SCREEN\"",
- "\"ALLOWED_FAILED_SCREEN\"",
- "\"ALLOWED\"",
- "\"PROHIB_NOT_SCREENED\"",
- "\"PROHIB_PASSED_SCREEN\"",
- "\"PROHIB_FAILED_SCREEN\"",
- "\"PROHIB\""
- ],
- "optional": true,
- "field": "callingpres",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "deny",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "permit",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "secret",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "md5secret",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "remotesecret",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "transport",
- "description": "<p>String is deprecated. Please use an Array as ["udp", "tcp"]</p>"
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"rfc2833\"",
- "\"info\"",
- "\"shortinfo\"",
- "\"inband\"",
- "\"auto\""
- ],
- "optional": true,
- "field": "dtmfmode",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\"",
- "\"nonat\"",
- "\"update\"",
- "\"outgoing\""
- ],
- "optional": true,
- "field": "directmedia",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "directrtpsetup",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "directmediapermit",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "directmediadeny",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "nat",
- "description": "<p>String is deprecated. Please use an Array as ["force_rport", "comedia"]</p>"
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "callgroup",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "namedcallgroup",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "pickupgroup",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "namedpickupgroup",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "language",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "tonezone",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": false,
- "field": "disallow",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": false,
- "field": "allow",
- "description": "<p>String is deprecated. Please use an Array as ["ulaw", "alaw", "gsm"]</p>"
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "autoframing",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "insecure",
- "description": "<p>String is deprecated. Please use an Array as ["port", "invite"]</p>"
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "trustrpid",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "trust_id_outbound",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\"",
- "\"never\""
- ],
- "optional": true,
- "field": "progressinband",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "promiscredir",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "useclientcode",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "accountcode",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "setvar",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "callerid",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "amaflags",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "callcounter",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "busylevel",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "allowoverlap",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "allowsubscribe",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "allowtransfer",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "ignoresdpversion",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "subscribecontext",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "template",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\"",
- "\"always\""
- ],
- "optional": true,
- "field": "videosupport",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "maxcallbitrate",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "rfc2833compensate",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "mailbox",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"accept\"",
- "\"refuse\"",
- "\"originate\""
- ],
- "optional": true,
- "field": "session_timers",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "session_expires",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "session_minse",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"uac\"",
- "\"uas\""
- ],
- "optional": true,
- "field": "session_refresher",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "t38pt_usertpsource",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "regexten",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "fromdomain",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "fromuser",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "qualify",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "keepalive",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "defaultip",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "defaultuser",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "rtptimeout",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "rtpholdtimeout",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "rtpkeepalive",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "sendrpid",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "outboundproxy",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "callbackextension",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "timert1",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "timerb",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "qualifyfreq",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "contactpermit",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "contactdeny",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "contactacl",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "unsolicited_mailbox",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "use_q850_reason",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "maxforwards",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "encryption",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "avpf",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "force_avp",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "icesupport",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "dtlsenable",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\"",
- "\"fingerprint\"",
- "\"certificate\""
- ],
- "optional": true,
- "field": "dtlsverify",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "dtlsrekey",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "dtlscertfile",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "dtlsprivatekey",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "dtlscipher",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "dtlscafile",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "dtlscapath",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"active\"",
- "\"passive\"",
- "\"actpass\""
- ],
- "optional": true,
- "field": "dtlssetup",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "dtlsfingerprint",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "usereqphone",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "recordonfeature",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "recordofffeature",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "call_limit",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "registertrying",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "subscribemwi",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "vmexten",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "mohinterpret",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "mohsuggest",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "parkinglot",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\"",
- "\"nonat\"",
- "\"update\"",
- "\"update,nonat\""
- ],
- "optional": true,
- "field": "canreinvite",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "loginInPause",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "resetPasswordToken",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "resetPasswordExpires",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "showWebBar",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Text",
- "optional": true,
- "field": "permissions",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "phoneBarUnconditionalNumber",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "phoneBarNoReplyNumber",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "phoneBarBusyNumber",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarUnconditional",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarNoReply",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarBusy",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarDnd",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarUnansweredCallBadge",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarEnableDtmfTone",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "phoneBarAutoAnswerDelay",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "extensionMonitor",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "crudPermissions",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "allowedValues": [
- "\"yes\"",
- "\"no\""
- ],
- "optional": true,
- "field": "rtcp_mux",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "allowmessenger",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "phoneBarOutboundProxy",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "passwordResetAt",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarEnableJaws",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarEnableScreenRecordingByAgent",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Virtual",
- "optional": true,
- "field": "phoneBarEnableVideoRecording",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarEnableAutomaticScreenRecording",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "phoneBarPrefixRequired",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "hotdesk",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "interface",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "privacyEnabled",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "apiKeyNonce",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "apiKeyIat",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "screenrecording",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "blocked",
- "description": ""
- },
- {
- "group": "Body",
- "type": "String",
- "optional": true,
- "field": "blockedAt",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Integer",
- "optional": true,
- "field": "loginAttempts",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Boolean",
- "optional": true,
- "field": "disabled",
- "description": ""
- }
- ]
- }
- },
- "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
- "version": "0.0.0",
- "filename": "server/api/user/index.js",
- "groupTitle": "Users"
- },
- {
"type": "put",
"url": "/api/users/{id}/password",
"title": "Change user password",
"groupTitle": "Users"
},
{
+ "type": "post",
+ "url": "/api/users/create_many",
+ "title": "Create Users",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "bulkCreate",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
"type": "get",
"url": "/api/users/{id}/avatar",
"title": "Get avatar",
},
{
"group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "userSecondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "userThirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
"type": "Text",
"optional": true,
"field": "location",
},
{
"type": "post",
- "url": "/api/webbar/hold",
- "title": "hold webrtc call",
+ "url": "/api/webbar/unhold",
+ "title": "unhold webrtc call",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
"type": "json"
}
],
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "sessionId",
"description": ""
},
},
{
"type": "post",
- "url": "/api/webbar/unhold",
- "title": "unhold webrtc call",
+ "url": "/api/webbar/hold",
+ "title": "hold webrtc call",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
"type": "json"
}
],
{
"group": "Body",
"type": "String",
- "optional": false,
+ "optional": true,
"field": "sessionId",
"description": ""
},
"optional": false,
"field": "name",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"first\"",
+ "\"second\"",
+ "\"third\""
+ ],
+ "optional": false,
+ "field": "level",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "description",
+ "description": ""
}
]
}
"group": "Body",
"type": "String",
"optional": true,
+ "field": "secondDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "thirdDisposition",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "note",
"description": ""
},
git://repos.xcallymotion.com / motion2.git / blobdiff