{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants Intents API", "version": "v2" }, "items": [ { "info": { "name": "Intents", "type": "folder" }, "items": [ { "info": { "name": "Get categories", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/intents/categories", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "queryValue", "value": "", "type": "query", "description": "Search query value to filter results by" } ] }, "docs": "Get categories" }, { "info": { "name": "Create category", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/intents/categories" }, "docs": "Create category" }, { "info": { "name": "Get category for categoryId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/intents/categories/:categoryId", "params": [ { "name": "categoryId", "value": "", "type": "path", "description": "Category id" } ] }, "docs": "Get category for categoryId" }, { "info": { "name": "Patch category for categoryId", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/intents/categories/:categoryId", "params": [ { "name": "categoryId", "value": "", "type": "path", "description": "Category id" } ] }, "docs": "Patch category for categoryId" }, { "info": { "name": "Delete category for categoryId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/intents/categories/:categoryId", "params": [ { "name": "categoryId", "value": "", "type": "path", "description": "Category id" } ] }, "docs": "Delete category for categoryId" }, { "info": { "name": "Create customer intent assignment for external contact", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/intents/assignments/externalcontacts/:externalContactId/customerintents/:customerIntentId/assignment", "params": [ { "name": "externalContactId", "value": "", "type": "path", "description": "External Contact id" }, { "name": "customerIntentId", "value": "", "type": "path", "description": "Customer Intent id" } ] }, "docs": "Create customer intent assignment for external contact" }, { "info": { "name": "Get customer intent assignments for externalContactId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/intents/assignments/externalcontacts/:externalContactId", "params": [ { "name": "externalContactId", "value": "", "type": "path", "description": "External Contact id" }, { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" } ] }, "docs": "Get customer intent assignments for externalContactId" }, { "info": { "name": "Get customer intent for customerIntentId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/intents/customerintents/:customerIntentId", "params": [ { "name": "customerIntentId", "value": "", "type": "path", "description": "Customer Intent id" } ] }, "docs": "Get customer intent for customerIntentId" }, { "info": { "name": "Patch customer intent for customerIntentId", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/intents/customerintents/:customerIntentId", "params": [ { "name": "customerIntentId", "value": "", "type": "path", "description": "Customer Intent id" } ] }, "docs": "Patch customer intent for customerIntentId" }, { "info": { "name": "Delete customer intent for customerIntentId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/intents/customerintents/:customerIntentId", "params": [ { "name": "customerIntentId", "value": "", "type": "path", "description": "Customer Intent id" } ] }, "docs": "Delete customer intent for customerIntentId" }, { "info": { "name": "Bulk remove source intents mapped to a customer intent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/intents/customerintents/:customerIntentId/sourceintents/bulk/remove", "params": [ { "name": "customerIntentId", "value": "", "type": "path", "description": "Customer Intent id" } ] }, "docs": "Bulk remove source intents mapped to a customer intent" }, { "info": { "name": "Bulk add source intents to a customer intent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/intents/customerintents/:customerIntentId/sourceintents/bulk/add", "params": [ { "name": "customerIntentId", "value": "", "type": "path", "description": "Customer Intent id" } ] }, "docs": "Bulk add source intents to a customer intent" }, { "info": { "name": "Get customer intents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/intents/customerintents", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "queryValue", "value": "", "type": "query", "description": "Search query value to filter results by" }, { "name": "categoryId", "value": "", "type": "query", "description": "CategoryId to filter query by" } ] }, "docs": "Get customer intents" }, { "info": { "name": "Create customer intents", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/intents/customerintents" }, "docs": "Create customer intents" }, { "info": { "name": "Get source intents mapped to a customer intent", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/intents/customerintents/:customerIntentId/sourceintents", "params": [ { "name": "customerIntentId", "value": "", "type": "path", "description": "Customer Intent id" }, { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "queryValue", "value": "", "type": "query", "description": "Search query value to filter results by" } ] }, "docs": "Get source intents mapped to a customer intent" }, { "info": { "name": "Get all mapped source intents by type. If no type selected default is type Segment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/intents/sourceintents", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "type", "value": "", "type": "query", "description": "Source Type to query by. If none selected default response will be for type Segment." }, { "name": "sourceId", "value": "", "type": "query", "description": "Source Id to query by. Only required for sourceType: Copilot, Bot, Digitalbot" } ] }, "docs": "Get all mapped source intents by type. If no type selected default is type Segment" } ] } ], "bundled": true }