},
{
"type": "post",
+ "url": "/api/auth/activedirectory",
+ "title": "Creates a new User token",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/auth/activedirectory -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Local_login",
+ "group": "Authentication",
+ "parameter": {
+ "fields": {
+ "Body": [
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "name",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "password",
+ "description": ""
+ }
+ ]
+ }
+ },
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/authActiveDirectory/index.js",
+ "groupTitle": "Authentication"
+ },
+ {
+ "type": "post",
"url": "/api/automations",
"title": "Creates a new Automation",
"examples": [
"optional": true,
"field": "vidaooSessionId",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "autoreplyExecuted",
+ "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",
"group": "Body",
"type": "String",
"optional": true,
+ "field": "labelText",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "messagesAlignment",
"description": ""
},
"optional": true,
"field": "vidaooApiKey",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": false,
+ "field": "vidaooTopic",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "vidaooNote",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "vidaooMetadata",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "openNewInteraction",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "subjectOffline",
+ "description": ""
}
]
}
"optional": true,
"field": "vidaooSessionId",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "autoreplyExecuted",
+ "description": ""
}
]
}
},
{
"type": "get",
+ "url": "/api/cloudProviders/oauth2/microsoft/authorize/{id}",
+ "title": "Generates the Microsoft Identity platform authorization url",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cloudProviders/oauth2/microsoft/authorize/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "Oauth2MicrosoftAuthorize",
+ "group": "CloudProviders",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cloudProvider/index.js",
+ "groupTitle": "CloudProviders"
+ },
+ {
+ "type": "post",
+ "url": "/api/cloudProviders/oauth2/microsoft/callback",
+ "title": "Receives an authorization code from Microsoft Identity platform",
+ "name": "Oauth2MicrosoftCallback",
+ "group": "CloudProviders",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cloudProvider/index.js",
+ "groupTitle": "CloudProviders"
+ },
+ {
+ "type": "get",
"url": "/api/cloudProviders/{id}",
"title": "Gets a single CloudProvider",
"examples": [
"groupTitle": "Cm_Hopper"
},
{
+ "type": "post",
+ "url": "/api/cm/hopper/previewrecall",
+ "title": "Gets Preview Dialer Contacts for Recall",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/hopper/previewrecall -d '{\"hopperId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getPreviewRecall",
+ "group": "Cm_Hopper",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmHopper/index.js",
+ "groupTitle": "Cm_Hopper"
+ },
+ {
"type": "put",
"url": "/api/cm/hopper/{id}",
"title": "Update an existing Hopper",
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
},
{
"type": "post",
- "url": "/api/fax/accounts/{id}/applications",
- "title": "Creates new applications",
+ "url": "/api/fax/accounts/addaccountapplications",
+ "title": "Creates new account and applications",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
"type": "json"
}
],
},
{
"type": "post",
- "url": "/api/fax/accounts/addaccountapplications",
- "title": "Creates new account and applications",
+ "url": "/api/fax/accounts/{id}/applications",
+ "title": "Creates new applications",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
"type": "json"
}
],
"groupTitle": "Fax_Messages"
},
{
- "type": "post",
- "url": "/api/fax/messages",
- "title": "Create message and send Fax",
+ "type": "put",
+ "url": "/api/fax/messages/{id}/reject",
+ "title": "Rejects message",
"examples": [
{
"title": "Example usage:",
],
"name": "rejectMessage",
"group": "Fax_Messages",
- "description": "<p>Motion 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/faxMessage/index.js",
"groupTitle": "Fax_Messages"
},
{
- "type": "put",
- "url": "/api/fax/messages/{id}/reject",
- "title": "Rejects message",
+ "type": "post",
+ "url": "/api/fax/messages",
+ "title": "Create message and send Fax",
"examples": [
{
"title": "Example usage:",
],
"name": "rejectMessage",
"group": "Fax_Messages",
- "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "description": "<p>Motion 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/faxMessage/index.js",
"groupTitle": "Fax_Messages"
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
},
{
"group": "Body",
- "type": "Text",
- "optional": true,
- "field": "lastMsgBody",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Text",
+ "type": "Boolean",
"optional": true,
- "field": "lastMsgText",
+ "field": "autoreplyExecuted",
"description": ""
}
]
},
{
"group": "Body",
- "type": "Text",
- "optional": true,
- "field": "lastMsgBody",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Text",
+ "type": "Boolean",
"optional": true,
- "field": "lastMsgText",
+ "field": "autoreplyExecuted",
"description": ""
}
]
"optional": true,
"field": "originCc",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "allowedValues": [
+ "\"Email\"",
+ "\"Chat\""
+ ],
+ "optional": false,
+ "field": "originChannel",
+ "description": ""
}
]
}
},
{
"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": "<p>Motion 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/notification/index.js",
- "groupTitle": "Notifications"
- },
- {
- "type": "post",
"url": "/api/openchannel/accounts/{id}/users",
"title": "Add agents to a openchannel account",
"examples": [
"optional": true,
"field": "from",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "autoreplyExecuted",
+ "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/voice/queues",
- "title": "Gets a list of RTVoiceQueues",
+ "url": "/api/rpc/outbound",
+ "title": "Gets a list of RTOutbound",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
+ "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
"type": "json"
}
],
"name": "RTVoiceQueues",
"group": "RPC_Realtime",
- "description": "<p>Motion will return a list of realtime voice queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "description": "<p>Motion will return a list of realtime outbound parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
"filename": "server/api/rpc/index.js",
"groupTitle": "RPC_Realtime"
},
{
"type": "get",
- "url": "/api/rpc/outbound",
- "title": "Gets a list of RTOutbound",
+ "url": "/api/rpc/voice/queues",
+ "title": "Gets a list of RTVoiceQueues",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
+ "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
"type": "json"
}
],
"name": "RTVoiceQueues",
"group": "RPC_Realtime",
- "description": "<p>Motion will return a list of realtime outbound parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "description": "<p>Motion will return a list of realtime voice queues parameters.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
"filename": "server/api/rpc/index.js",
"groupTitle": "RPC_Realtime"
"groupTitle": "RPC_Realtime"
},
{
+ "type": "put",
+ "url": "/api/rpc/voice/{id}/queues",
+ "title": "Updates a single VoiceQueue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "UpdateVoiceQueues",
+ "group": "RPC_Realtime",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
"type": "post",
"url": "/api/rpc/agents/:id/notify",
"title": "Notify message to a specific agent",
"groupTitle": "RPC_Realtime"
},
{
+ "type": "get",
+ "url": "/api/realtime/agents",
+ "title": "Gets realtime agents info",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/realtime/agents -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getAgents",
+ "group": "Realtime",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/realtime/index.js",
+ "groupTitle": "Realtime"
+ },
+ {
+ "type": "get",
+ "url": "/api/realtime/queues",
+ "title": "Gets realtime queues info",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/realtime/queues -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getQueues",
+ "group": "Realtime",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/realtime/index.js",
+ "groupTitle": "Realtime"
+ },
+ {
"type": "post",
"url": "/api/integrations/salesforce/accounts",
"title": "Creates a new Salesforce Account",
"allowedValues": [
"\"contact_lead\"",
"\"contact\"",
- "\"lead\""
+ "\"lead\"",
+ "\"account_contact_lead\"",
+ "\"account\""
],
"optional": true,
"field": "moduleSearch",
"allowedValues": [
"\"nothing\"",
"\"contact\"",
- "\"lead\""
+ "\"lead\"",
+ "\"account\""
],
"optional": true,
"field": "moduleCreate",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "leadId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "additionalSearchAccount",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "additionalSearchContact",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "additionalSearchLead",
+ "description": ""
}
]
}
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
"optional": false,
"field": "lastMsgDirection",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "autoreplyExecuted",
+ "description": ""
}
]
}
},
{
"type": "delete",
- "url": "/api/square/recordings/{id}/delete",
+ "url": "/api/square/recordings/{id}",
"title": "Delete recording",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/square/recordings/{id}/delete -v -u {name}:{password} -X DELETE",
+ "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",
"type": "json"
}
],
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
},
{
"type": "delete",
- "url": "/api/whatsapp/queues/{id}/teams",
+ "url": "/api/openchannel/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/openchannel/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/openchannelQueue/index.js",
"groupTitle": "Teams"
},
{
"type": "delete",
- "url": "/api/openchannel/queues/{id}/teams",
+ "url": "/api/voice/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/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/openchannelQueue/index.js",
+ "filename": "server/api/voiceQueue/index.js",
"groupTitle": "Teams"
},
{
"type": "delete",
- "url": "/api/voice/queues/{id}/teams",
- "title": "Remove teams from a queue",
+ "url": "/api/voice/Prefixes/{id}/teams",
+ "title": "Remove teams from a voice prefix",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
+ "content": "curl https://{domain}/api/voice/prefixes/{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/voicePrefix/index.js",
"groupTitle": "Teams"
},
{
},
{
"type": "delete",
- "url": "/api/chat/queues/{id}/teams",
+ "url": "/api/whatsapp/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/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/chatQueue/index.js",
+ "filename": "server/api/whatsappQueue/index.js",
"groupTitle": "Teams"
},
{
},
{
"type": "delete",
+ "url": "/api/chat/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",
+ "type": "json"
+ }
+ ],
+ "name": "RemoveTeams",
+ "group": "Teams",
+ "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/chatQueue/index.js",
+ "groupTitle": "Teams"
+ },
+ {
+ "type": "delete",
"url": "/api/fax/queues/{id}/teams",
"title": "Remove teams from a queue",
"examples": [
"optional": true,
"field": "description",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "privacyEnabled",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "downloadAttachments",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "downloadCallySquareRecordings",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "downloadContactManagerLists",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "downloadJscriptySessions",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "downloadOmnichannelInteractions",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "downloadScreenRecordings",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "downloadVoiceRecordings",
+ "description": ""
}
]
}
},
{
"type": "get",
+ "url": "/api/users/{id}/open_tabs",
+ "title": "Get interactions opened tabs",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getOpenTabs",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
+ "type": "get",
"url": "/api/users/presence",
"title": "Gets agent presence",
"examples": [
{
"group": "Body",
"type": "String",
- "optional": false,
+ "optional": true,
"field": "stamp",
"description": ""
}
},
{
"type": "post",
+ "url": "/api/voice/prefixes/{id}/teams",
+ "title": "Add teams to voice prefix",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "AddTeams",
+ "group": "Voice_Prefix",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voicePrefix/index.js",
+ "groupTitle": "Voice_Prefix"
+ },
+ {
+ "type": "get",
+ "url": "/api/voice/prefixes/{id}/teams",
+ "title": "Gets voice prefix team",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "GetTeams",
+ "group": "Voice_Prefix",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voicePrefix/index.js",
+ "groupTitle": "Voice_Prefix"
+ },
+ {
+ "type": "post",
"url": "/api/voice/prefixes/{id}/users",
"title": "Add agents to a prefix",
"examples": [
"optional": true,
"field": "dialPredictiveIntervalMinThreshold",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "dialPreviewAutoRecallMe",
+ "description": ""
}
]
}
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
},
{
"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": "lastMsgDirection",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "autoreplyExecuted",
+ "description": ""
}
]
}
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
git://repos.xcallymotion.com / motion2.git / blobdiff