"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",
"optional": true,
"field": "readAt",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
}
]
}
"groupTitle": "Chat_Interactions"
},
{
+ "type": "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": true,
"field": "readAt",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
}
]
}
"optional": true,
"field": "vidaooApiKey",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "openNewInteraction",
+ "description": ""
}
]
}
},
{
"type": "get",
+ "url": "/api/cm/contacts/{id}/journey",
+ "title": "Gets customer journey",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getJourney",
+ "group": "Cm_Contacts",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/cmContact/index.js",
+ "groupTitle": "Cm_Contacts"
+ },
+ {
+ "type": "get",
"url": "/api/cm/contacts/{id}/jscripty_sessions",
"title": "Gets contact hopper blacks",
"examples": [
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "serverUrl",
"description": ""
},
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "serverUrl",
"description": ""
},
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
},
{
"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"
}
],
},
{
"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"
}
],
"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"
},
{
- "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"
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "serverUrl",
"description": ""
}
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "serverUrl",
"description": ""
}
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
"Body": [
{
"group": "Body",
- "type": "String",
+ "type": "Text",
"optional": true,
"field": "question",
"description": ""
"Body": [
{
"group": "Body",
- "type": "String",
+ "type": "Text",
"optional": true,
"field": "question",
"description": ""
"optional": false,
"field": "lastMsgDirection",
"description": ""
- },
- {
- "group": "Body",
- "type": "Text",
- "optional": true,
- "field": "lastMsgBody",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Text",
- "optional": true,
- "field": "lastMsgText",
- "description": ""
}
]
}
"optional": false,
"field": "lastMsgDirection",
"description": ""
- },
- {
- "group": "Body",
- "type": "Text",
- "optional": true,
- "field": "lastMsgBody",
- "description": ""
- },
- {
- "group": "Body",
- "type": "Text",
- "optional": true,
- "field": "lastMsgText",
- "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": "readAt",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
}
]
}
"optional": true,
"field": "readAt",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
}
]
}
"groupTitle": "Plugins"
},
{
- "type": "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"
"groupTitle": "RPC_Realtime"
},
{
+ "type": "put",
+ "url": "/api/rpc/voice/{id}/queues",
+ "title": "Updates a single VoiceQueue",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "UpdateVoiceQueues",
+ "group": "RPC_Realtime",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
"type": "post",
"url": "/api/rpc/agents/:id/notify",
"title": "Notify message to a specific agent",
},
{
"type": "get",
+ "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
+ "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "openchannelQueuesIdWaitingInteractions",
+ "group": "RPC_Realtime",
+ "description": "<p>Motion will return a list of realtime waiting openchannel queues interctions.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/rpc/index.js",
+ "groupTitle": "RPC_Realtime"
+ },
+ {
+ "type": "get",
"url": "/api/rpc/openchannel/queues/waitinginteractions",
"title": "Gets a list of openchannelQueuesWaitingInteractions",
"examples": [
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "serverUrl",
"description": ""
},
"allowedValues": [
"\"contact_lead\"",
"\"contact\"",
- "\"lead\""
+ "\"lead\"",
+ "\"account_contact_lead\"",
+ "\"account\""
],
"optional": true,
"field": "moduleSearch",
"allowedValues": [
"\"nothing\"",
"\"contact\"",
- "\"lead\""
+ "\"lead\"",
+ "\"account\""
],
"optional": true,
"field": "moduleCreate",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "leadId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "additionalSearchAccount",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "additionalSearchContact",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "additionalSearchLead",
+ "description": ""
}
]
}
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "serverUrl",
"description": ""
}
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
},
{
"type": "get",
+ "url": "/api/settings/now",
+ "title": "Get Server Current Date",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/settings/now -v -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getDate",
+ "group": "Settings",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/setting/index.js",
+ "groupTitle": "Settings"
+ },
+ {
+ "type": "get",
"url": "/api/settings/{id}/favicon",
"title": "Get Favicon",
"examples": [
"\"clicksend\"",
"\"plivo\"",
"\"clickatell\"",
+ "\"bandwidth\"",
"\"csc\"",
"\"infobip\"",
"\"intelepeer\""
"group": "Body",
"type": "String",
"optional": true,
+ "field": "applicationId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "accountId",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
"field": "senderString",
"description": ""
},
"groupTitle": "Sms_Accounts"
},
{
- "type": "post",
- "url": "/api/sms/messages/{id}/status",
- "title": "Receive message status",
+ "type": "get",
+ "url": "/api/sms/accounts/{id}/status",
+ "title": "Receive message status as get request",
"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 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/smsMessage/index.js",
+ "filename": "server/api/smsAccount/index.js",
"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",
- "url": "/api/sms/accounts/{id}/status",
+ "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 POST",
+ "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
"type": "json"
}
],
"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>",
"version": "0.0.0",
- "filename": "server/api/smsAccount/index.js",
+ "filename": "server/api/smsMessage/index.js",
"groupTitle": "Sms_Accounts"
},
{
"optional": true,
"field": "secret",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
}
]
}
"optional": true,
"field": "secret",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
}
]
}
"optional": false,
"field": "direction",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
}
]
}
"optional": true,
"field": "production",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "savedAt",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "publishedAt",
+ "description": ""
}
]
}
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "serverUrl",
"description": ""
}
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
},
{
"type": "delete",
- "url": "/api/fax/queues/{id}/teams",
+ "url": "/api/whatsapp/queues/{id}/teams",
"title": "Remove teams from a queue",
"examples": [
{
"title": "Example usage:",
- "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
+ "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
"type": "json"
}
],
"group": "Teams",
"description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
- "filename": "server/api/faxQueue/index.js",
+ "filename": "server/api/whatsappQueue/index.js",
"groupTitle": "Teams"
},
{
"type": "delete",
- "url": "/api/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",
+ "url": "/api/chat/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/chat/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/chatQueue/index.js",
"groupTitle": "Teams"
},
{
"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"
}
],
"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/mailQueue/index.js",
"groupTitle": "Teams"
},
{
"type": "delete",
- "url": "/api/mail/queues/{id}/teams",
+ "url": "/api/fax/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/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
"type": "json"
}
],
"group": "Teams",
"description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
"version": "0.0.0",
- "filename": "server/api/mailQueue/index.js",
+ "filename": "server/api/faxQueue/index.js",
"groupTitle": "Teams"
},
{
},
{
"type": "post",
+ "url": "/api/userNotifications",
+ "title": "Send notification to user",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
+ "type": "json"
+ }
+ ],
+ "name": "Send",
+ "group": "UserNotifications",
+ "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/userNotification/index.js",
+ "groupTitle": "UserNotifications"
+ },
+ {
+ "type": "post",
"url": "/api/userProfile/resources",
"title": "Creates a new User Profile Resource",
"examples": [
"optional": true,
"field": "description",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Boolean",
+ "optional": true,
+ "field": "privacyEnabled",
+ "description": ""
}
]
}
"groupTitle": "Users"
},
{
+ "type": "get",
+ "url": "/api/users/presence",
+ "title": "Gets agent presence",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/users/presence -v -u {name}:{password} -X GET",
+ "type": "json"
+ }
+ ],
+ "name": "getPresence",
+ "group": "Users",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/user/index.js",
+ "groupTitle": "Users"
+ },
+ {
"type": "put",
"url": "/api/users/{id}",
"title": "Update an existing User",
{
"group": "Body",
"type": "String",
- "optional": false,
+ "optional": true,
"field": "stamp",
"description": ""
}
"groupTitle": "Voice_Recordings"
},
{
- "type": "get",
+ "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 -v -u {name}:{password} -X GET",
+ "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
"type": "json"
}
],
"name": "transcribe",
"group": "Voice_Recordings",
- "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/voiceRecording/index.js",
"groupTitle": "Voice_Recordings"
},
{
- "type": "post",
+ "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 -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
+ "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
"type": "json"
}
],
"name": "transcribe",
"group": "Voice_Recordings",
- "description": "<p>Motion will return a HTTP status code <code>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/voiceRecording/index.js",
"groupTitle": "Voice_Recordings"
},
{
"type": "get",
+ "url": "/api/voice/transfers/reports/describe",
+ "title": "Gets table info about Transfer Reports",
+ "examples": [
+ {
+ "title": "Example usage:",
+ "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
+ "type": "json"
+ }
+ ],
+ "name": "DescribeTransfer_Reports",
+ "group": "Voice_Transfer_Reports",
+ "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
+ "version": "0.0.0",
+ "filename": "server/api/voiceTransferReport/index.js",
+ "groupTitle": "Voice_Transfer_Reports"
+ },
+ {
+ "type": "get",
"url": "/api/voice/transfers/reports",
"title": "Gets a list of Transfer Reports",
"examples": [
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "serverUrl",
"description": ""
},
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
"optional": true,
"field": "secret",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
}
]
}
"optional": true,
"field": "secret",
"description": ""
+ },
+ {
+ "group": "Body",
+ "type": "String",
+ "optional": true,
+ "field": "providerName",
+ "description": ""
+ },
+ {
+ "group": "Body",
+ "type": "Text",
+ "optional": true,
+ "field": "providerResponse",
+ "description": ""
}
]
}
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "serverUrl",
"description": ""
},
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
{
"group": "Body",
"type": "String",
- "optional": true,
+ "optional": false,
"field": "serverUrl",
"description": ""
},
"\"string\"",
"\"variable\"",
"\"customVariable\"",
- "\"keyValue\""
+ "\"keyValue\"",
+ "\"picklist\""
],
"optional": true,
"field": "type",
git://repos.xcallymotion.com / motion2.git / blobdiff