For more information, please visit: https://developers.facebook.com/docs/whatsapp/guides/opt-in/" }, { "name": "Users", "description": "
**Users** are people recorded in CommBox and they include both the business side and the customers.
Managers are APIs that deal with the business personas such as Admins, Agents, Team leaders, etc., and they include **Profiles**, **Presence**, **Assignments**, **Notifications**, and **Teams** sub-categories.
General USERS" }, { "name": "Managers", "description": "
The **MANAGERS** APIs category relates to activities involving the Admins, Team Leaders, Agents, and any other business-related persona. This category includes **Profiles**, **Presence**, **Assignments**, **Notifications**, and **Teams** sub-categories." }, { "name": "Profiles", "description": "
**Profiles** relate to system permissions and enabled activities assigned to a group of agents (managers).
When looking for a specific user, the USER ID is required.
The profile ID is required when selecting a specific profile (See Enum section)." }, { "name": "Presence", "description": "
The Presence APIs relate to the agent availability status. Active and ready for assignment, Busy, or Away from the desk. Additional statuses can be created by the admin." }, { "name": "Assignments", "description": "
The **Assignments** category relates to conversations (Objects) assigned to a specific agent." }, { "name": "Teams", "description": "A Team is a group of agents with specific business agendas, roles, and permissions. Admins and Team Managers can set up Team Managers to create and manage teams and give those teams specific inbox filters, tags, and knowledge-based assets." }, { "name": "Automation", "description": "
Automation APIs are related to bot capabilities." } ], "info": { "title": "CommBox API", "x-logo": { "url": "https://www.commbox.io/logo/commbox_logo_large.png" }, "description": "\n# About CommBox\n## Overview\nCommBox redefines the way businesses interact with their customers by providing seamless interactions between different communication modalities, deep integration with customer relations management platforms, and innovative business solutions to improve agents’ productivity and service abilities, all while saving time by reducing manual efforts via our automation.\n\nThis document provides the information needed for developers to use CommBox’s resources, whether server-based or client-side.\n\nThe CommBox Developers platform lets you access CommBox data and functionality using code instead of the user interface. \nFor example, you can use the platform to:\n* Create a new agent and assign that agent to a specific team.\n* Create a WhatsApp template. \n* Send follow-up SMS/text reminders. \n* Receive Webhooks based on pre-set triggers in CommBox.\n\nCommbox Omnichannel Structure
\n\n# Security and Authentication\n## Overview\nThe CommBox REST API is served over HTTPS, and unencrypted HTTP is not supported to ensure data privacy.In addition, all requests are required to pass Bearer Token (BearerAuth) for authentication, where the token is predetermined and provided by CommBox.\n\nAll requests are logged and validated. \n\nAll parameters **must** be URL-encoded.\n\n* **Security Scheme Type**: HTTPS\n\n* **HTTP Authorization Scheme**: bearer\n\n## Obtaining an API Key / Access Token\n\n**Note**: **Admin** privileges are required in order to obtain the **Access Token / API Key**.\n\n**A Bearer Token must be set in the Authorization header of every API call.**\n\nIn the CommBox console, navigate to **Settings** > **API** (in the Settings & Features section): \n1. Click the **View** icon next to the API Key.\n2. Click the **Copy** icon on the right.\n3. At the request Authorization tab, select Bearer Token from the Type dropdown list.\n4. At the Token field, paste your Access Token / API Key value. \n\n**Warning**: API tokens can pose a security risk to your organization if used by an unauthorized person. Make sure to keep them secure. Delete old keys and replace them in your system if you suspect any security breach.\n\n## Replacing/Rotating API Tokens\n\nAPI Keys rotate automatically in a pre-set schedule. To reset that schedule or obtain a new key, follow the steps below:\n\n1. Navigate to **Settings** > **API**.\n2. Click the **Revoke** icon at the far right of the existing API Key.\n A new dialog box will inform you have a 30-day grace period to replace the old key with the new one. Click the **Revoke Key** button.\n3. At the new dialog box, determine how long the new key will be active. You may copy it to other locations from there or do so later within your 30-day grace period.\n4. Finish the process by clicking **Done**. The New API key is displayed above the old one. After 30 days, the old API key will expire.\n5. You may delete the **Revoked/Expired** key by clicking the Trash Bin icon.\n\n
\n\n## Obtaining a STREAM ID\nA **STREAM ID** is required for every communication channel (Chat, WhatsApp, etc.). \n If you don’t know the Stream ID, substitute it with the encrypted version (called StreamProviderId): \n1. At the CommBox console, navigate to **Settings** and select the communication channel.\n2. Click on the communication channel of your choice from the listed channels. The ID number issued by CommBox is right underneath the channel name. \n3. Place this code wherever you see the **{STREAM_ID}** section of the API. \n\n Example:\n \n https://api.commbox.io/streams/{STREAM_ID}/objects \n \n https://api.commbox.io/streams/hNyRN_fLUy7rrOrN9jLpipA%3d%3d/objects\n \n 
\n \n # Single Sign-on (SSO) and Authentication modules\nCommBox offers several options for authentication and silent login into our systems in addition to our standard user/password login process.\n## Directory Services\nWe allow a login for our management site using Directory Services (DS) providers (such as Active Directory).\n\nTo set it up, the Single Sign-On module must be active, and the domain, username, and password (optional) must be set in the Module Settings tab. Furthermore, every user who wishes to log in using Directory Services must also set the Username field on the Users Management page.\n\nOnce configured, the system will try to validate the username and password fields inputted on the login page against the DS server. If successful, the user will be automatically signed into the system. Otherwise, the system will try to validate the user/password field using the standard CommBox credentials.\n## Ticket Authentication\nWe allow a login for our management site and some apps using a custom-signed ticket for authentication. The ticket is created using our Ticket API\n\nThe ticket must be signed by the sending party using our API. The signed ticket is then passed using either a query string or a POST parameter and verified by the system. If successful and the provided user identifiers are valid, a session cookie will be created and returned to the user. If an existing cookie is found, it will be overwritten and extended.\n\n **Note**: A user with these parameters must be set up via the management site in advance.\n Tickets used to log into our management site must include the Business account name (brand) and the username. If the ticket is used to log in to different apps, it must include all the required parameters for that specific app. (For example, FirstName, LastName, Phone, email address, etc.)\n \n **Note**: Once created, tickets are only valid for 60 seconds for the management system and 5 minutes for other applications\n \n # CommBox REST APIs\n ## Overview\n\nCommBox utilizes the REST APIs principles, allowing developers to perform queries to the CommBox platform. We support GET, POST, and DELETE requests.\nUse a **Get** request to retrieve information, a **POST** to create or update an entity, and a **DELETE** to remove an entity. \nAfter receiving the request, the API sends back an HTTP code as a response in JSON format.\nClick here for API Glossary.\n\n## Structure and Examples\n### Access Token \nAll API requests require an Access Token to validate authenticity to indicate to the system what modules, operations, and resources the user can access. See more detailed information in the Security and Authentication section of this documentation.\n\n### Base URI \nAll URLs referenced in the documentation have the following base: [https://api.commbox.io](https://api.commbox.io)\n\n\n### Request\n\n* The request must include the **module** and **operation** in the URI.\nFor example, to access an operation called **SystemStatus** in the **Core** module, make an HTTP request to –\n/Core/SystemStatus\n\n* To receive specific information regarding a resource, use the provided parameters in the URI. \nFor example, to access a specific user data in the Core module, make an HTTP GET request to –\n/Users/{USER_ID}/Details\n\n* To change a resource, use an HTTP POST request to the resource URI.\nFor example, to change a specific user name in the Core module, make an HTTP POST request to –\nPOST /Users/{USER_ID}/Details \nAnd include the post parameter\ndata={\\\"FirstName\\\":\\\"FIRSTNAME\\\", \\\"LastName\\\":\\\"LASTNAME\\\"}\n\n\n* To delete a resource, use an HTTP DELETE request to the resource URI.\nFor example, to change a specific user name in the Core module, make an HTTP DELETE request to –\nDELETE /Users/{USER_ID}/\n\n\n### Response\n\nProperty | Description\n------------- | -------------\nstatus | The HTTP status code for the response\ndescription | A more informative message\nresponse_time | UTC Timestamp for the operation\ndata | (Optional) Additional output data, varies by operation\n\n\n\n### Possible Response Status Codes\n\nStatus Code | Description | Notes\n------------- | ------------- | -\n200 | OK | The request was successful\n400 | Bad Request | The request could not be understood by the server. Incoming parameters might not be valid\n401 | Unauthorized | The supplied credentials, if any, are not sufficient to access the resource\n404 | Not Found | The requested resource is not found\n429 | Too Many Requests | Too many requests have been made in a short period of time (Throttling)\n500 | Server Error | The server could not return the representation due to an internal server error\n501 | Not Implemented | The requested operation is not supported (e.g. supports GET but not POST etc.)\n\n### API Calls Examples\nOur various API can be found under the \"API Calls Section\" \n\n# Webhooks\n## Overview\nA webhook sends an HTTP POST request to a specified URL responding to a trigger (an “event”) in CommBox.\nFor example, every time a new user is created or deleted, CommBox will send a notification to the callback URL provided by the client. The webhook system of notification and updates eliminates continuous or periodic requests when changes haven’t occurred.\n\n**Note:** We strongly recommend using an HTTPS callback URL with a strong encrypted certificate.\n\nTo register for this service, contact your CommBox CS. \n\n## Webhook Structure \nAll updates contain a wrapper called “Event,” which indicates the subscription source and name of the trigger event. Inside the wrapper will be the actual data relevant to this update.\n\n**Note:** Notifications can be transferred as XML objects. \n\n ### Xml Example\n For a new object that was received on commbox’s servers, an “OnNew” event will be triggered and posted to the client callback URL:\n \n
\n\nAvailable CRM integrations include **Salesforce**, **Microsoft Dynamics**, **SAP C4C** and more. \n\n## Widgets\nWe provide several premade widgets for embedding our Inbox or Object (conversation) in your Dashboards or CRM. These widgets isolate the Object from the rest of the platform, allowing CommBox clients to incorporate them into their 3rd party system.\n To only view the dialog box of the CommBox platform, use this URL:\n [https://manange.commbox.io](https://manange.commbox.io)\n To only view a specific Object (conversation), use this URL with the Conversation Id:\n [https://manange.commbox.io/widget/object/{Object_Id}](https://manange.commbox.io/widget/object/{Object_Id}) \nTo obtain the Object Id, click on the 3-vertical-dots menu at the top left corner of the main pane. The Id is displayed at the bottom of that window. \n\n## Desktop Management Customization\nCommbox allows CSS customization for most page elements and specific JavaScript code elements for client-side events. Contact us for more information.\n\n# Data structures \nThis section describes all of the data structures the API recognizes and sends\n\n**Objects** are conversations between the bots or the agents and the customers, where each segment of the conversation is referred to as a **Child**. Every conversation must have a designated **Stream** – a communication channel such as Chat, email, SMS, etc., that hosts the conversation.\n\nThe Object category concentrates on a specific conversation, where the stream is part of the identifying parameters. In the Streams category, the channel is the focal point of the request, and the objects and users are the filtering aspects of the request.\n\n## Object\nProperty | Value | Description | Notes\n------------- | ------------- | - | -\nId | int64 | Object ID. This is a Commbox generated number | \nStreamId | int64 | Stream ID to which the object is connected | \nSubStreamId | int64 | Sub Stream ID to which the object is connected | \nType | short | The type of the object | Object Types\nStatusId | string | Current status ID| ObjectStatusType\nCreatedTime| datetime | When the object was created | In UTC time\nFirstResponseTime | datetime | When the first response to the object was registered | In UTC time\nUpdatedTime | datetime | When the object was last updated | In UTC time\nPriorityTime | datetime | When the object is currently prioritized | In UTC time\nNumChilds | int | Number of child objects relating to this parent object | \nIsManager | bool | Indicates whether this object was created by a manager |\nNumTags | int | Number of tags assigned to this object|\nMessage| string | The text containing the object’s primary message |\nContent | JSON string | String containing extended properties of the object |\nUser | object | The user that created the object| User\n\n## Object Child\nProperty | Value | Description | Notes\n------------- | ------------- | - | -\nId | int64 | Child ID. This is a Commbox generated number |\nType | short | The type of the child | Object Types\nIsManager | bool | Indicates whether this child was created by a manager |\nCreatedTime| datetime | When the child was created | In UTC time\nMessage| string | The text containing the child’s primary message |\nContent | JSON string | String containing extended properties of the child |\nUser | object | The user that created the child| User\n\n## ObjectActivityLog\nProperty | Value | Description | Notes\n------------- | ------------- | - | -\nText | string | Text content in the activity log |\nSource | string | The source of the activity log (optional) | \nManagerId | Int64 | The manager who initialize the activity log (optional) |\n\n## Tag\nProperty | Value | Description | Notes\n------------- | ------------- | - | -\nId | int64 | Tag ID. This is a Commbox generated number |\n\n ## User\nProperty | Value | Description | Notes\n------------- | ------------- | - | -\nId | int64 | User ID. This is a Commbox generated number |\nUniqueId | string(50) | User’s unique identifier. This can be an email, social security number or any other type of unique string determined by the brand administrators |\nPhone1 | Numeric string(20) | User’s phone number | Always contains country code and without leading + or 00\nPhone2| Numeric string(20) | User’s additional phone number | Always contains country code and without leading + or 00\nEmail | string (255) | User’s email address |\nFirstName | string (100) | User’s first name |\nLastName | string (100) | User’s last name |\nGender | string (1) | User’s gender | ‘M’ for male, ‘F’ for female\nLocale | object | User’s locale |\nBirthday | date | User’s birthday | Date only\nNumIdentities | int | Number of active identities that are connected to this user |\nIsManager | bool | Indicates whether this user is a manager |\nRemarks | string | Free text containing general remarks about the user | \nIdentity | object | Identity object that is connected to the user | User Identity\n\n## User Identity\nProperty | Value | Description | Notes\n------------- | ------------- | - | -\nId | int64 | Identity ID. This is a Commbox generated number and used throughout all the updates |\nStream Provider Id | string(255) | Identity’s unique identifier as it appears at the original provider |\nStream Provider Type | int64 | Type of the original provider | StreamProviderType\nStream Provider Email| string(255) | Identity’s email as it appears at the original provider |\nUserName | string (100) | Identity’s user name as it appears at the original provider |\nFirstName | string (100) | Identity’s first name as it appears at the original provider |\nLastName | string (100) | Identity’s last name as it appears at the original provider |\nThumbnailUrl | string (255) | Link to the identity’s profile image |\nNumObjects | int | Number of objects connected to this identity |\n\n## Manager\nProperty | Value | Description | Notes\n------------- | ------------- | - | -\nId | int64 | Manager ID. This is a Commbox generated number and used throughout all the updates |\nAsyncAssignedNoResponse | int | Current number of assigned asynchronous objects awaiting response |\nAsyncAssignedInProccess | int | Current number of assigned asynchronous objects that are being addressed by the manager |\nSyncAssignedNoResponse| int | Current number of assigned synchronous objects awaiting response (Chat/messenger conversations) |\nSyncAssignedInProccess | int | Current number of assigned synchronous objects that are being addressed by the manager (Chat/messenger conversations) |\nFaceToFaceStatus | bool | Returns true if the manager is busy with a face to face object (Voice/Video call) |\nTotalAsyncAssigned | int | Total number of currently assigned objects |\nTotalSyncAssigned | int | Total number of currently assigned synchronous objects (Chat/messenger conversations) |\n\n## Object custom indicator\nProperty | Value | Description | Notes\n------------- | ------------- | - | -\nIndicatorId | string | Indicator id (unique name) – to allow updating/ deleting existing indicator |\nDisplayClass | string | Indicator class. Mandatory only if Icon has not provided | You must provide DisplayClass or an Icon, or both\nIcon | string | An icon for the indicator. Supports URL. Mandatory only if Icon has not provided (not relevant for DELETE operation) |\nTitle| string | A title for the indicator (not relevant for DELETE operation) |\n\n# Enums\n## ObjectType\n Text = 0\n Link = 1
\n Photo = 2
\n Video = 3
\n Conversation = 4
\n Mail = 5
\n Audio = 6
\n Location = 7
\n voice = 8
\n Review = 9
\n Form = 10
\n System Message = 11
\n Option = 12
\n InputData = 13
\n Contacts = 14
\n Album = 15
\n TemplateMessage = 16
CampaignMessage = 17
SurveyMessage = 18
\n\n## ObjectStatusType\n Open = 1
\n Resolved = 2
\n Forward = 3
\n Irrelevant = 4
\n Deleted = 5
\n Forward Reply = 6
\n Draft = 7
\n In Process = 8
\n Scheduled = 9
\n Follow Up = 10
\n Automated = 11
\n Sent = 13
\n Archive = 14
\n Pending = 15
\n\n## StreamProviderType\n Commbox = 0
\n Facebook = 1
\n Twitter = 2
\n YouTube = 3
\n Mail = 4
\n Telephone = 5
\n Anonymous = 6
\n WhatsApp = 7
\n Web = 8
\n AppleAppStore = 9
\n Instagram= 10
\n Google = 11
\n Telegram = 12
\n GoogleMyBusiness = 13
\n Microsoft365 = 14
\n Gmail = 15
WhatsAppCloud = 16
Salesforce = 17
\n\n## ObjectActivityType\n Remark = 1
\n StatusChange = 2
\n Forward = 3
\n ForwardReply = 4
\n StreamChange = 5
\n AssignChange = 6
\n UpdateObjectTag = 7
\n FollowUp = 8
\n UpdateObjectIntent = 9
\n Attachment = 10
\n RuleExecuted = 11
\n Custom = 12
\n UpdateObjectPublicity = 13
\n Debug = 14
\n InvalidExtensionFile = 15
\n InvalidFileSize = 16
\n DisallowedFileUpload = 17
\n inactivityLogout = 18
\n ParticipantChange = 19
\n TargetStreamChange = 20
\n ConversationSummary = 21
\n LogError = 22
\n RedactChild = 23
\n\n## ModuleType\n GENERAL = 0
\n CUSTOMER_SERVICE = 1
\n FACEBOOK_PAGE_CONNECTOR = 3
\n STATIC_CONTENT = 4
\n MAILBOX_CONNECTOR = 6
\n YOUTUBE_CONNECTOR = 7
\n TWITTER_CONNECTOR = 8
\n CHAT = 9
\n WEB_SYNDICATION_CONNECTOR = 10
\n FACEBOOK_MONITOR_CONNECTOR = 11
\n WHATSAPP = 13
\n SMS = 14
\n VOICE = 15
\n SSO = 16
\n MANAGE_CLIENT_CUSTOMIZATIONS = 17
\n APPLE_APPSTORE_REVIEWS = 18
\n GOOGLE_PLAY_REVIEWS = 19
\n INSTAGRAM_CONNECTOR = 20
\n CONTACT_US = 21
\n CUSTOMER_SATISFACTIONS = 22
\n AUTOMATION_SCRIPT = 23
\n INTENTS = 24
\n INTERACTIVE_NAVIGATOR = 25
\n WEBRTC_VIDEO_CHAT = 26
\n WEBRTC_AUDIO_CHAT = 27
\n FORMS = 28
\n CUSTOMER_VERIFICATION = 29
\n DYNAMICS_CRM_CONNECTOR = 31
\n CUSTOM_FIELDS = 32
\n RIGHTNOW_CRM = 33
\n RULES = 34
\n EXTERNAL_CONTACTS = 35
\n WORKING_HOURS = 36
\n CUSTOM = 37
\n FACEBOOK_MESSENGER = 38
\n MAINTENANCE = 39
\n PRIVACY_AND_SECURITY = 40
\n AUTO_ASSIGN = 41
\n TWO_FACTOR_AUTHENTICATION = 42
\n THEMES = 43
\n TELEGRAM = 44
\n GOOGLE_MY_BUSINESS = 45
\n SAP_CRM = 46
\n SLA = 47
\n PUSH_NOTIFICATIONS = 48
\n SYS_AID = 49
\n WORKFLOW = 50
\n GOOGLE_TRANSLATE = 51
\n PRIORITY = 53
\n JIRA = 54
\n GOOGLE_BUSINESS_MESSAGES = 55
\n BI_CUSTOM_REPORTS = 57
\n SALESFORCE = 58
\n AI_ASSISTANT = 59
\n API = 60
\n Zendesk = 61
\n Teams = 65
\n Hubspot = 71
\n\n## Presence Types\n Active = 1
\n Busy = 2
\n Away = 3
\n \n## User Permission Types\n Unauthorized user = 0
\n Normal - Customer communicating with agent = 1
\n Agent = 2
\n Admin = 3
\n Bot = 5
\n \n## Tags Types \n Tag = 1
\n Goal = 2
\n Miss = 3
\n Support Tag = 4
\n Intents = 100
\n Customer Satisfaction = 101
\n SLA = 102
\n Customer Satisfaction Open Answer = 103
\n \n \n \n \n# API CALLS\n \n", "version": "2.07", "termsOfService": "https://www.commbox.io/end-user-license-agreement-eula/", "contact": { "name": "commbox", "url": "https://www.commbox.io", "email": "contactus@commbox.io" } }, "servers": [ { "url": "https://api.commbox.io/", "description": "Production server" } ], "security": [ { "BearerAuth": [] } ], "x-tagGroups": [ { "name": "API Calls", "tags": [ "Core", "Objects", "Streams", "Tags", "SMS", "WhatsApp", "Users", "Managers", "Profiles", "Presence", "Assignments", "Teams", "Forms", "Ticket", "Automation" ] } ], "paths": { "/core/systemstatus": { "get": { "tags": [ "Core" ], "summary": "System Status", "description": "returns the current state of the systemJSON Example:
https://api.commbox.io/core/systemstatus", "operationId": "systemStatus", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "System is operational" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "string", "example": null } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/streams/{STREAM_ID}/streamavailability": { "get": { "tags": [ "Streams" ], "summary": "Get Stream Availability", "description": "Returns information regarding the requested stream availability(GET) /streams/STREAM_ID/streamavailability/ignoreAutomationExsistance
Example:
https://api.bumpyardpro.com/streams/STREAM_ID/streamavailability/false", "operationId": "Get_Stream_Availability", "parameters": [ { "name": "STREAM_ID", "in": "path", "description": "Stream ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/STREAM_ID" } }, { "name": "ignoreAutomationExsistance", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "state": { "type": "integer", "example": 1 } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/streams/{STREAM_ID}/objects": { "get": { "tags": [ "Streams" ], "summary": "Get Stream Objects", "description": "This API returns information about all Objects (conversations) in the requested Stream (channel).
You must use the query params to limit and organize the returned information:
a) To get all Objects of a specific user, enter either UserIdentityId or both IdentityStreamProviderId and IdentityStreamProviderType.
b) For all Objects within a range of time, enter both unixStartTime and unixEndTime (Unix Time Stamp format).
c) Use the Sort, Order, etc. optional parameters to limit and organize the output.
Note: Object's children and activity logs are False by default.", "operationId": "Get_Stream_Objects", "parameters": [ { "name": "STREAM_ID", "in": "path", "description": "Stream ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/STREAM_ID" } }, { "$ref": "#/components/parameters/userIdentityId" }, { "$ref": "#/components/parameters/identityStreamProviderId" }, { "$ref": "#/components/parameters/identityStreamProviderType" }, { "$ref": "#/components/parameters/unixStartTime" }, { "$ref": "#/components/parameters/unixEndTime" }, { "$ref": "#/components/parameters/subStream" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/order" }, { "$ref": "#/components/parameters/includeChilds" }, { "$ref": "#/components/parameters/includeActivityLog" }, { "$ref": "#/components/parameters/timeFilter" }, { "$ref": "#/components/parameters/pageNumber" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/status" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "System is operational" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "example": 123456 }, "streamid": { "type": "integer", "example": 1 }, "substreamid": { "type": "integer", "example": 1 }, "type": { "type": "integer", "example": 0 }, "isManager": { "type": "boolean", "example": false }, "statusId": { "type": "integer", "example": 1 }, "createdTime": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "updatedTime": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "lastResponseTime": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "priorityTime": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "streamProviderId": { "type": "string", "example": "11111111_222222" }, "streamProviderType": { "type": "integer", "example": "1" }, "message": { "type": "string", "example": "New status from facebook, Hello world!" }, "content": { "type": "string", "example": "{\"num_likes\":5,\"user_likes\":false,\"num_shares\":2}" }, "numChilds": { "type": "integer", "example": "1" }, "numTags": { "type": "integer", "example": "1" }, "user": { "type": "object", "properties": { "id": { "type": "integer", "example": 123 }, "identity": { "type": "object", "properties": { "id": { "type": "integer", "example": 1234 }, "streamProviderId": { "type": "string", "example": "11111111_222222" }, "streamProviderType": { "type": "integer", "example": "1" }, "streamProviderEmail": { "type": "string", "example": "yuval@gmail.com" }, "firstName": { "type": "string", "example": "Yuval" }, "lastName": { "type": "string", "example": "Hakim" } } } } } } }, { "type": "object", "properties": { "id": { "type": "integer", "example": 234 }, "streamid": { "type": "integer", "example": 1 }, "substreamid": { "type": "integer", "example": 1 }, "type": { "type": "integer", "example": 0 }, "isManager": { "type": "boolean", "example": false }, "statusId": { "type": "integer", "example": 1 }, "createdTime": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "updatedTime": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "lastResponseTime": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "priorityTime": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "streamProviderId": { "type": "string", "example": "11111111_333333" }, "streamProviderType": { "type": "integer", "example": "1" }, "message": { "type": "string", "example": "New status from facebook, Hello world!" }, "content": { "type": "string", "example": "{\"num_likes\":5,\"user_likes\":false,\"num_shares\":2}" }, "numChilds": { "type": "integer", "example": "2" }, "numTags": { "type": "integer", "example": "0" }, "user": { "type": "object", "properties": { "id": { "type": "integer", "example": 123 }, "identity": { "type": "object", "properties": { "id": { "type": "integer", "example": 1234 }, "streamProviderId": { "type": "string", "example": "11111111_222222" }, "streamProviderType": { "type": "integer", "example": "1" }, "streamProviderEmail": { "type": "string", "example": "yuval@gmail.com" }, "firstName": { "type": "string", "example": "Yuval" }, "lastName": { "type": "string", "example": "Hakim" } } } } } } } ] } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } }, "post": { "tags": [ "Objects" ], "summary": "Create Object", "description": "This API creates a Conversation in a specified channel and returns an Object Id.
Sends the Stream (channel) id with body parameters.", "operationId": "Create_Object", "parameters": [ { "name": "STREAM_ID", "in": "path", "description": "Stream ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/STREAM_ID" } } ], "requestBody": { "description": "Description of request body parameters", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" }, "examples": { "Mail": { "value": { "data": { "Type": 5, "StatusId": 1, "StreamProviderType": 4, "StreamProviderId": "b9910a75a46c492c9cf46a910cdba0012", "UserStreamProviderId": "somestream@gmail.com", "UserStreamProviderType": 4, "Content": { "subject": "mail subject" }, "Message": "some message", "User": { "UniqueId": "01234567", "LastName": "Doe", "FirstName": "John", "Phone1": "05055555555", "Email": "JohnDoe@gmail.com", "Remarks": "some remark for user" } } } }, "SMS": { "value": { "data": { "Type": 4, "StatusId": 1, "StreamProviderType": 5, "StreamProviderId": "972544444444", "UserStreamProviderId": "972544444444", "UserStreamProviderType": 5, "Message": "some message", "User": { "UniqueId": "01234567", "LastName": "Doe", "FirstName": "John", "Phone1": "972544444444", "Email": "JohnDoe@gmail.com", "Remarks": "some remark for user" } } } }, "SMS Multi-recipient": { "value": { "data": { "Type": 4, "StatusId": 1, "StreamProviderType": 5, "UserStreamProviderId": "972544444444", "UserStreamProviderType": 5, "sendToClient": true, "Content": { "to": [ "972522222222" ] }, "Message": "some message", "User": { "UniqueId": "01234567", "LastName": "Doe", "FirstName": "John", "Phone1": "972544444444", "Email": "JohnDoe@gmail.com", "Remarks": "some remark for user" } } } }, "WhatsApp": { "value": { "data": { "Type": 4, "StatusId": 1, "StreamProviderType": 7, "StreamProviderId": "972544444444", "UserStreamProviderId": "972544444444", "UserStreamProviderType": 5, "Content": { "to": [ "972522222222" ], "whatsapp_hsm_name": "test_template", "whatsapp_localizable_params": [ "check_1" ], "whatsapp_language_code": "en" }, "Message": "some message", "User": { "UniqueId": "01234567", "LastName": "Doe", "FirstName": "John", "Phone1": "972544444444", "Email": "JohnDoe@gmail.com", "Remarks": "some remark for user" } } } }, "Chat": { "value": { "data": { "Type": 4, "StatusId": 1, "StreamProviderType": 0, "UserStreamProviderId": "972544444444", "UserStreamProviderType": 5, "UserIdentity": 100000000419660, "Message": "some message", "createChildObject": true, "User": { "UniqueId": "01234567", "LastName": "Doe", "FirstName": "John", "Phone1": "972544444444", "Email": "JohnDoe@gmail.com", "Remarks": "some remark for user" } } } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "data": { "description": "send object as JSON", "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "OK" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "id": { "type": "integer", "example": 294159 } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/streams/{STREAM_ID}/objects/{OBJECT_ID}/child": { "post": { "tags": [ "Objects" ], "summary": "Create Child Object", "description": "Create new child object for specific object in stream
(POST) /streams/STREAM_ID/objects/OBJECT_ID/child
(POST) /streams/STREAM_ID/objects/STREAM_PROVIDER_ID/STREAM_PROVIDER_TYPE/child", "operationId": "Create_Child_Object", "parameters": [ { "name": "STREAM_ID", "in": "path", "description": "Stream ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/STREAM_ID" } }, { "name": "OBJECT_ID", "in": "path", "description": "Object ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/OBJECT_ID" } } ], "requestBody": { "description": "Optional description for new mail object in *Markdown*", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object_Child" }, "example": { "data": { "Type": 5, "UserStreamProviderId": "somemail@gmail.com", "UserStreamProviderType": 4, "Message": "some message" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "OK" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "id": { "type": "integer", "example": 294159 } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/streams/{STREAM_ID}/objects/{OBJECT_ID}": { "get": { "tags": [ "Objects" ], "summary": "Get Object", "description": "This API returns the details of a specific conversation (object).
Data includes information about the customer, the agent, and a separate account of the messages (Child) of the conversation (Object).
Note that the last communication will appear at the top of the report.
Required path params are the **Stream (channel) Id** and **Object (conversation) Id** - Stream Id could be encrypted or not. (GET) /streams/STREAM_ID/objects/OBJECT_ID
Example:
https://api.commbox.io/streams/532/objects/293854
Note: When Children are not included in the request, the API only returns the last message. When requesting logs (optional), the return will include all system actions (for example, CRM activity) for the conversation. ", "operationId": "Get_Object", "parameters": [ { "name": "STREAM_ID", "in": "path", "description": "Stream Id is a CommBox generated number for the channel.", "required": true, "schema": { "$ref": "#/components/parameters/STREAM_ID" } }, { "name": "OBJECT_ID", "in": "path", "description": "Object Id is a CommBox generated number for the conversation.", "required": true, "schema": { "$ref": "#/components/parameters/OBJECT_ID" } }, { "$ref": "#/components/parameters/includeChilds" }, { "$ref": "#/components/parameters/includeActivityLog" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "System is operational" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "objectId": { "description": "A CommBox generated number for the conversation", "type": "integer", "example": 293854 }, "streamid": { "description": "A CommBox generated number for the channel – This will be the unencrypted format of the channel Id.", "type": "integer", "example": 53211 }, "substreamid": { "description": "A CommBox generated number for the subchannel. A Sub-stream is not required when calling an API.", "type": "integer", "example": 2432 }, "streamProviderId": { "type": "string", "example": "972505555555" }, "streamProviderType": { "type": "integer", "example": "5" }, "user_identity": { "type": "integer", "example": "528986" }, "firstName": { "description": "When not provided, system will use the email address.", "type": "string", "example": "Eddie" }, "lastName": { "type": "string", "example": "Doe" }, "userStreamProviderId": { "description": "The unique Id for communication (email, phone number)", "type": "string", "example": "972505555555_by" }, "userStreamProviderType": { "description": "A CommBox generated number – see Enums", "type": "integer", "example": "5" }, "content": { "description": "
Summary of the technical aspects of communication. May include the language used, direction (Rt. for Arabic and Hebrew), URL of origin, system details (assignments to agent, acceptance of email, etc.), subject matter (emails), and an initiation time.", "type": "string", "example": "{\\\"guidRT\\\":\\\"82c952166e0b4989b932c41d1\\\",\\\"languages\\\":[{\\\"Item1\\\":\\\"he\\\",\\\"Item2\\\":1329062}],\\\"originUrl\\\":\\\"https://apps.commbox.com/Demo\\\",\\\"isConnected\\\"true,\\\"first_assigned_time\\\":\\\"2023-09-05T08:44:20\\\",\\\"sequence_start_time\\\":\\\"2023-09-0508:55:06.000000\\\",\\\"dropOutAggregationState\\\":1}" }, "message": { "type": "string", "example": "I need some help" }, "createdTime": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "updatedTime": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "closeTime": { "type": "string", "example": "null" }, "statusId": { "type": "integer", "example": 1 }, "assignedManagerId": { "description": "Id of agent / admin", "type": "integer", "example": 0 }, "type": { "type": "integer", "example": 4 }, "isManager": { "description": "If True: User is an agent / admin If False: User is a customer", "type": "boolean", "example": false }, "user": { "type": "object", "properties": { "id": { "type": "integer", "example": 520760 }, "uniqueId": { "type": "string", "example": 12345 }, "phone1": { "description": "As appears in the Customer Info section. System adds country code.", "type": "string", "example": 972531234567 }, "phone2": { "type": "string", "example": 972501234332 }, "email": { "type": "string", "example": "eddiedoe053@gmail.com" }, "firstName": { "type": "string", "example": "Eddie" }, "lastName": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "Male" }, "numberIdentities": { "type": "integer", "example": 3 }, "locale": { "type": "string", "example": "en_US" }, "birthday": { "type": "string", "example": "01/01/1980" }, "remarks": { "type": "string", "example": "test remark.." }, "content": { "type": "string", "example": "{}" }, "childs": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "example": 123456 }, "object_id": { "type": "integer", "example": 1234 }, "content": { "type": "string", "example": "{}" }, "message": { "type": "string", "example": "some message..." }, "createdTime": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "streamProviderType": { "type": "integer", "example": "5" }, "user": { "type": "object", "properties": { "id": { "type": "integer", "example": 520760 }, "managerId": { "type": "integer", "example": 0 }, "isManager": { "type": "boolean", "example": false }, "identity": { "type": "object", "properties": { "id": { "type": "integer", "example": 531826 }, "streamProviderId": { "type": "string", "example": "972505555555" }, "streamProviderType": { "type": "integer", "example": "5" }, "firstName": { "type": "string", "example": null }, "lastName": { "type": "string", "example": null }, "thumbnailUrl": { "type": "string", "example": null } } } } } } }, { "type": "object", "properties": { "id": { "type": "integer", "example": 978944 }, "object_id": { "type": "integer", "example": 1234 }, "content": { "type": "string", "example": "{}" }, "message": { "type": "string", "example": "some other message..." }, "createdTime": { "type": "string", "example": "2014-08-06T07:55:52.2581942Z" }, "streamProviderType": { "type": "integer", "example": "5" }, "user": { "type": "object", "properties": { "id": { "type": "integer", "example": 520803 }, "managerId": { "type": "integer", "example": 520803 }, "isManager": { "type": "boolean", "example": true }, "identity": { "type": "object", "properties": { "id": { "type": "integer", "example": 531811 }, "streamProviderId": { "type": "string", "example": "michae12@gmail.com" }, "streamProviderType": { "type": "integer", "example": 0 }, "firstName": { "type": "string", "example": "michael" }, "lastName": { "type": "string", "example": "null" }, "thumbnailUrl": { "type": "string", "example": null } } } } } } } ] } } } } } } ] } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/streams/{STREAM_ID}/objects/{OBJECT_ID}/transcript": { "get": { "tags": [ "Objects" ], "summary": "Get Object's Transcript", "description": "This API returns the transcript of a specific conversation (object).
Data includes information about the conversation (objectId), customer, the channel, sub-channel.
Note: The transcript field includes the conversation transcript with an external hyperlink to the Object (conversation) .
Required path params are the **Stream (channel) Id** and **Object (conversation) Id** - Stream Id could be encrypted or not. (GET) /streams/STREAM_ID/objects/OBJECT_ID/transcript
Example:
https://api.commbox.io/streams/532/objects/293854/transcript
", "operationId": "Get_Object_Transcript", "parameters": [ { "name": "STREAM_ID", "in": "path", "description": "Stream Id is a CommBox generated number for the channel.", "required": true, "schema": { "$ref": "#/components/parameters/STREAM_ID" } }, { "name": "OBJECT_ID", "in": "path", "description": "Object Id is a CommBox generated number for the conversation.", "required": true, "schema": { "$ref": "#/components/parameters/OBJECT_ID" } } ], "responses": { "200": { "description": "Operation successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2024-03-19T10:45:41.6038344Z" }, "data": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "objectId": { "description": "A CommBox generated number for the conversation", "type": "integer", "example": 378015 }, "streamid": { "description": "A CommBox generated number for the channel – This will be the unencrypted format of the channel Id.", "type": "integer", "example": 17558 }, "substreamid": { "description": "A CommBox generated number for the subchannel. A Sub-stream is not required when calling an API.", "type": "integer", "example": 0 }, "trasncript": { "description": "
trasncript of the conversation.", "type": "string", "example": "\\n[2/29/2024 12:20:25 PM] \\nBot : \\nTEST!@$$%^&*()}{\\\":<>?🙁🙁🙁🙁 6_312aac6109.jpg \\n[2/29/2024 12:20:30 PM] \\nJohn Doe: \\nhi \\n[2/29/2024 12:21:05 PM] \\nJohn Doe: \\nAttachments: \\nmashu_mashu_251a989981_25a7e7f517.png \\n[2/29/2024 12:21:22 PM] \\nRan Itzhaki: \\nok \\n[2/29/2024 12:21:29 PM] \\nBot : \\nResolved \\nWispp Object Id: 378015 \\nCommbox Ticket Link: https://qawispp.wispp.com/widget/object/378015" }, "user": { "type": "object", "properties": { "id": { "type": "integer", "example": 537385 }, "uniqueId": { "type": "string", "example": 537385 }, "phone1": { "description": "As appears in the Customer Info section. System adds country code.", "type": "string", "example": 972505445875 }, "phone2": { "type": "string", "example": "" }, "email": { "type": "string", "example": "test115@gmail.com" }, "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Doe" }, "gender": { "type": "string", "example": "Male" }, "numberIdentities": { "type": "integer", "example": 3 }, "locale": { "type": "string", "example": "en_US" }, "birthday": { "type": "string", "example": "01/01/1980" }, "remarks": { "type": "string", "example": null } } } } } ] } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/streams/{STREAM_ID}/objects/{OBJECT_ID}/tags/{TAG_ID}": { "post": { "tags": [ "Tags" ], "summary": "Set Object Tag", "description": "This API is used to tag a conversation with a specific tag.
Required path parameters included the Stream (channel) Id, Object (conversation) Id, and the desired Tag Id.(POST) /streams/{STREAM_ID}/objects/{OBJECT_ID}/tags/{TAG_ID}
Example: https://api.wispp.com/streams/17566/objects/372235/tags/2789", "operationId": "Set_Object_Tag", "parameters": [ { "name": "STREAM_ID", "in": "path", "description": "Stream ID. This is a CommBox generated number for the channel", "required": true, "schema": { "$ref": "#/components/parameters/STREAM_ID" } }, { "name": "OBJECT_ID", "in": "path", "description": "Object ID. This is a CommBox generated number for the conversation", "required": true, "schema": { "$ref": "#/components/parameters/OBJECT_ID" } }, { "name": "TAG_ID", "in": "path", "description": "Tag ID. This is a CommBox generated number for each tag", "required": true, "schema": { "$ref": "#/components/parameters/TAG_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "string", "example": null } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } }, "delete": { "tags": [ "Tags" ], "summary": "Delete Object Tag", "description": "This API is used to delete a specific tag from a conversation.
Required path parameters included the Stream (Channel) Id, Object (conversation) Id, and the desired Tag Id. (DELETE) /streams/{STREAM_ID}/objects/{OBJECT_ID}/tags/{TAG_ID}
Example: https://api.wispp.com/streams/17566/objects/372235/tags/2789", "operationId": "Delete_Object_Tag", "parameters": [ { "name": "STREAM_ID", "in": "path", "description": "Stream ID. This is a CommBox generated number for the channel", "required": true, "schema": { "$ref": "#/components/parameters/STREAM_ID" } }, { "name": "OBJECT_ID", "in": "path", "description": "Object ID. This is a CommBox generated number for the conversation", "required": true, "schema": { "$ref": "#/components/parameters/OBJECT_ID" } }, { "name": "TAG_ID", "in": "path", "description": "Tag ID. This is a CommBox generated number for each tag", "required": true, "schema": { "$ref": "#/components/parameters/TAG_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "string", "example": null } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/users/{USER_ID}": { "get": { "tags": [ "Users" ], "summary": "Get User", "description": "Get user informationIn order to get data, must use either UserId or both streamProviderId and streamProviderType of the user identity", "operationId": "Get_User", "parameters": [ { "name": "USER_ID", "in": "path", "description": "User ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/USER_ID" } }, { "name": "streamProviderId", "in": "query", "description": "Only return objects created by this user. Represents the user identity. Must supply streamProviderType as well (optional)", "schema": { "type": "string" } }, { "name": "streamProviderType", "in": "query", "description": "Only return objects created by this user. Represents the user identity. Must supply streamProviderId as well (optional)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "id": { "type": "integer", "example": "1769668," }, "firstName": { "type": "string", "example": "Bob" }, "lastName": { "type": "string", "example": "Cohen" }, "gender": { "type": "string", "example": "Male" }, "phone1": { "type": "string", "example": 972547724967 }, "phone2": { "type": "string", "example": null }, "uniqueId": { "type": "string", "example": 266684 }, "email": { "type": "string", "example": "redlich@appnext.com" }, "content": { "type": "string", "example": "{}" }, "permissionId": { "type": "integer", "example": 1 }, "numIdentities": { "type": "integer", "example": 2 }, "numObjects": { "type": "integer", "example": 0 }, "locale": { "type": "string", "example": "en_US" }, "remarks": { "type": "string", "example": "test remark.." }, "userTags": { "type": "string", "example": "[{\"id\":1007,\"name\":\"test\",\"group_name\":null}]" }, "teamId": { "type": "integer", "example": 0 }, "identities": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "example": 1957166 }, "userId": { "type": "integer", "example": 1769668 }, "numObjects": { "type": "integer", "example": 0 }, "userName": { "type": "string", "example": null }, "streamProviderEmail": { "type": "string", "example": "redlich@appnext.com" }, "streamProviderId": { "type": "string", "example": "redlich@appnext.com" }, "streamProviderType": { "type": "integer", "example": 4 }, "firstName": { "type": "string", "example": "Bob" }, "lastName": { "type": "string", "example": "Cohen" }, "thumbnailUrl": { "type": "string", "example": null }, "content": { "type": "string", "example": "{}" } } }, { "type": "object", "properties": { "id": { "type": "integer", "example": 2158778 }, "userId": { "type": "integer", "example": 1769668 }, "numObjects": { "type": "integer", "example": 0 }, "userName": { "type": "string", "example": null }, "streamProviderEmail": { "type": "string", "example": "מוךך" }, "streamProviderId": { "type": "string", "example": 972547724967 }, "streamProviderType": { "type": "integer", "example": 5 }, "firstName": { "type": "string", "example": "Bob" }, "lastName": { "type": "string", "example": "Cohen" }, "thumbnailUrl": { "type": "string", "example": null }, "content": { "type": "string", "example": "{}" } } } ] } } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } }, "post": { "tags": [ "Users" ], "summary": "Update User", "description": "This API updates the user information in the **Customer Info** pane.
Add to the body params the new information with their corresponding unique name field as they appear in the **Custom Fields** module.
Fields added to the Custom Fields module are included in the **Content** field of the API (See example).
Make sure to enter the field’s name exactly as it appears in the **unique name** column.
Once successful, this API returns the User ID. ", "operationId": "Update_User", "parameters": [ { "name": "USER_ID", "in": "path", "description": "User ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/USER_ID" } } ], "requestBody": { "description": "Optional description for new mail object in *Markdown*", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" }, "example": { "data": { "UniqueId": "0123456789", "LastName": "Doe", "FirstName": "John", "Phone1": "19175555555", "Email": "JohnDoe@gmail.com", "Remarks": "some remark for user", "Content": { "brand_name": "XYZ Corp.", "Account_Number": "303103" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2024-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "Id": { "type": "integer", "example": 94382332 } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/users/identities/{USER_IDENTITY_ID}/objects": { "get": { "tags": [ "Users" ], "summary": "Get User Objects", "description": "Get user objectsIn order to get data, must use either userIdentityId or both streamProviderId and streamProviderType of the user identity", "operationId": "Get_User_Objects", "parameters": [ { "name": "USER_IDENTITY_ID", "in": "path", "description": "Only return objects created by this user", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "streamProviderId", "in": "query", "description": "Only return objects created by this user. Represents the user identity. Must supply streamProviderType as well (optional)", "schema": { "type": "string" } }, { "name": "streamProviderType", "in": "query", "description": "Only return objects created by this user. Represents the user identity. Must supply streamProviderId as well (optional)", "schema": { "type": "string" } }, { "name": "stream", "in": "query", "description": "The stream Id from which to return objects (optional, default 0)", "schema": { "type": "integer", "format": "int64" } }, { "$ref": "#/components/parameters/subStream" }, { "$ref": "#/components/parameters/pageNumber" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/status" }, { "name": "order", "in": "query", "description": "The order to return the objects (optional, default 'closedtime')", "schema": { "type": "string" } }, { "name": "objectId", "in": "query", "description": "The object id to filter (optional, default 0)", "schema": { "type": "integer", "format": "int64" } }, { "name": "moduleId", "in": "query", "description": "The module id to filter (optional, default 0)", "schema": { "type": "integer", "format": "int64" } }, { "name": "includeChilds", "in": "query", "description": "Flag to return the object childs (optional, default true)", "schema": { "type": "boolean", "example": true } }, { "name": "includeActivityLog", "in": "query", "description": "Flag to return the object activity log (optional, default false)", "schema": { "type": "boolean", "example": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "objectId": { "type": "integer", "example": 1234 }, "streamId": { "type": "integer", "example": 4444 }, "subStreamId": { "type": "integer", "example": 0 }, "streamProviderId": { "type": "string", "example": "11111111_222222" }, "streamProviderType": { "type": "integer", "example": 1 }, "user_identity": { "type": "integer", "example": 528986 }, "firstName": { "type": "string", "example": "Yuval" }, "lastName": { "type": "string", "example": "Hakim" }, "userStreamProviderId": { "type": "string", "example": "972505555555_by" }, "userStreamProviderType": { "type": "integer", "example": 4 }, "content": { "type": "string", "example": "{\"num_likes\":5,\"user_likes\":false,\"num_shares\":2}" }, "message": { "type": "string", "example": "some message" }, "createdTime": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "updatedTime": { "type": "string", "example": "2014-08-07T06:51:52.2581942Z" }, "closedTime": { "type": "string", "example": "2014-08-07T07:51:52.2581942Z" }, "firstResponseTime": { "type": "string", "example": "2014-08-06T08:00:52.2581942Z" }, "lastResponseTime": { "type": "string", "example": "2014-08-06T08:00:52.2581942Z" }, "statusId": { "type": "integer", "example": 1 }, "assignedManagerId": { "type": "integer", "example": 0 }, "type": { "type": "integer", "example": 0 }, "user": { "type": "object", "properties": { "id": { "type": "integer", "example": "1769668," }, "firstName": { "type": "string", "example": "Bob" }, "lastName": { "type": "string", "example": "Cohen" }, "gender": { "type": "string", "example": "Male" }, "phone1": { "type": "string", "example": 972547724967 }, "phone2": { "type": "string", "example": null }, "uniqueId": { "type": "string", "example": 266684 }, "email": { "type": "string", "example": "redlich@appnext.com" }, "content": { "type": "string", "example": "{}" }, "locale": { "type": "string", "example": "en_US" }, "remarks": { "type": "string", "example": "test remark.." }, "birthday": { "type": "string", "example": "01/01/1990" }, "numberIdentities": { "type": "integer", "example": 3 } } }, "isManager": { "type": "boolean", "example": false }, "childs": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "example": 123456 }, "object_id": { "type": "integer", "example": 1234 }, "content": { "type": "string", "example": "{}" }, "message": { "type": "string", "example": "some message..." }, "createdTime": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "streamProviderType": { "type": "integer", "example": "5" }, "user": { "type": "object", "properties": { "id": { "type": "integer", "example": 520760 }, "managerId": { "type": "integer", "example": 0 }, "isManager": { "type": "boolean", "example": false }, "identity": { "type": "object", "properties": { "id": { "type": "integer", "example": 531826 }, "streamProviderId": { "type": "string", "example": "972505555555" }, "streamProviderType": { "type": "integer", "example": "5" }, "firstName": { "type": "string", "example": null }, "lastName": { "type": "string", "example": null }, "thumbnailUrl": { "type": "string", "example": null } } } } } } }, { "type": "object", "properties": { "id": { "type": "integer", "example": 978944 }, "object_id": { "type": "integer", "example": 1234 }, "content": { "type": "string", "example": "{}" }, "message": { "type": "string", "example": "some other message..." }, "createdTime": { "type": "string", "example": "2014-08-06T07:55:52.2581942Z" }, "streamProviderType": { "type": "integer", "example": "5" }, "user": { "type": "object", "properties": { "id": { "type": "integer", "example": 520803 }, "managerId": { "type": "integer", "example": 520803 }, "isManager": { "type": "boolean", "example": true }, "identity": { "type": "object", "properties": { "id": { "type": "integer", "example": 531811 }, "streamProviderId": { "type": "string", "example": "michae12@gmail.com" }, "streamProviderType": { "type": "integer", "example": 0 }, "firstName": { "type": "string", "example": "michael" }, "lastName": { "type": "string", "example": "null" }, "thumbnailUrl": { "type": "string", "example": null } } } } } } } ] } } } } ] } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/objects/{OBJECT_ID}/status/{STATUS_ID}": { "post": { "tags": [ "Objects" ], "summary": "Set Object Status", "description": "The conversation’s status indicates where the conversation has reached or heading. Statuses include “Open”, “Resolved”, “Archived”, etc.
This API updates the status of the conversation. See the Enum section for the Object Status Type.
Required path parameters include the Object (Conversation) Id and the desired updated status Id.", "operationId": "Set_Object_Status", "parameters": [ { "name": "OBJECT_ID", "in": "path", "description": "Object ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/OBJECT_ID" } }, { "name": "STATUS_ID", "in": "path", "description": "Status ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/STATUS_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "string", "example": null } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/objects/{OBJECT_ID}/content": { "post": { "tags": [ "Objects" ], "summary": "Set Object Content", "description": "Set the object's content", "operationId": "Set_Object_Content", "parameters": [ { "name": "OBJECT_ID", "in": "path", "description": "Object ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/OBJECT_ID" } } ], "requestBody": { "description": "Optional description for new mail object in *Markdown*", "required": false, "content": { "application/json": { "schema": { "type": "object", "example": { "data": { "num_likes": 8, "is_hidden": false } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "string", "example": null } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/objects/{OBJECT_ID}/activitylog": { "post": { "tags": [ "Objects" ], "summary": "Add Activity Log", "description": "Add activity log to object", "operationId": "Set_Activity_Log", "parameters": [ { "name": "OBJECT_ID", "in": "path", "description": "Object ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/OBJECT_ID" } } ], "requestBody": { "description": "Optional description for new mail object in *Markdown*", "required": false, "content": { "application/json": { "schema": { "type": "object", "example": { "data": { "Text": "test!", "Source": "testing", "ManagerId": 1111 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "string", "example": null } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/objects/{OBJECT_ID}/remarks": { "post": { "tags": [ "Objects" ], "summary": "Add Remark Log", "description": "Add remark log to object", "operationId": "Set_Remark_Log", "parameters": [ { "name": "OBJECT_ID", "in": "path", "description": "Object ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/OBJECT_ID" } } ], "requestBody": { "description": "Optional description for new mail object in *Markdown*", "required": false, "content": { "application/json": { "schema": { "type": "object", "example": { "data": { "Text": "test!", "ManagerId": 1111 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "string", "example": null } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/objects/{OBJECT_ID}/indicators": { "post": { "tags": [ "Objects" ], "summary": "Set Custom Indicator", "description": "Sets or updates an object's custom indicator", "operationId": "Set_Object_Indicator", "parameters": [ { "name": "OBJECT_ID", "in": "path", "description": "Object ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/OBJECT_ID" } } ], "requestBody": { "description": "Optional description for new mail object in *Markdown*", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "IndicatorId": { "type": "string" }, "Title": { "type": "string" }, "DisplayClass": { "type": "string" }, "Link": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "string", "example": null } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/objects/{OBJECT_ID}/indicators/{INDICATOR_ID}": { "delete": { "tags": [ "Objects" ], "summary": "Delete Custom Indicator", "description": "Delete an object's custom indicator", "operationId": "Delete", "parameters": [ { "name": "OBJECT_ID", "in": "path", "description": "Object ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/OBJECT_ID" } }, { "name": "INDICATOR_ID", "in": "path", "description": "Indicator ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/INDICATOR_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "string", "example": null } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/managers/{MANAGER_ID}/stats": { "get": { "tags": [ "Managers" ], "summary": "Get Manager Stats", "description": "Based on the agent’s Id, this API returns information about the current number of assignments based on the different statuses.
Required parameter is the Manager Id (agent/admin Id number generated by CommBox)
API returns the Agent’s current assignments tally.", "operationId": "Get_Manager_stats", "parameters": [ { "name": "MANAGER_ID", "in": "path", "description": "Manager ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/MANAGER_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "id": { "type": "integer", "example": 520760, "description": "The agent's Id number" }, "AsyncAssignedNoResponse": { "type": "integer", "example": 2, "description": "Current number of assigned asynchronous conversations (objects) awaiting a response" }, "AsyncAssignedInProccess": { "type": "integer", "example": 1, "description": "Current number of assigned asynchronous conversations (objects) that are being addressed by the manager" }, "SyncAssignedNoResponse": { "type": "integer", "example": 0, "description": "Current number of assigned synchronous conversations (objects) awaiting a response" }, "SyncAssignedInProccess": { "type": "integer", "example": 0, "description": "Current number of assigned synchronous conversations (objects) that are being addressed by the manager" }, "FaceToFaceStatus": { "type": "boolean", "example": false, "description": "Returns true if the agent is busy with a face-to-face conversation (Voice/Video call)" }, "TotalAsyncAssigned": { "type": "integer", "example": 3, "description": "Total number of currently assigned Asynchronous conversations." }, "TotalSyncAssigned": { "type": "integer", "example": 0, "description": "Total number of currently assigned Synchronous conversations." } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/managers/{MANAGER_ID}": { "get": { "tags": [ "Managers" ], "summary": "Get Manager", "description": "This API returns information about a specific agent or an administrator based on the manager Id (required).", "operationId": "Get_Manager", "parameters": [ { "name": "MANAGER_ID", "in": "path", "description": "Manager ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/MANAGER_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "id": { "type": "integer", "example": 520760, "description": "The manager’s id number" }, "content": { "type": "string", "example": "{\"user_color\":\"\",\"_isEmailVerified\":true,\"_activationState\":\"Handled\"}", "description": "Lists related statuses about the agent/admin: Active state – shows the user’s status, Password verification, Email verification, Chosen color" }, "identityId": { "type": "integer", "example": "2192427", "description": "CommBox associates conversations with a customer via a specified communication channel. A customer may have a few identities when the conversation is using more than one communication channel. For agents/admins, this number is irrelevant and just identifies the user as a Manager. " }, "streamProviderId": { "type": "string", "example": "john.s@gmail.com", "description": "Access point – usually the email" }, "thumbnailUrl": { "type": "string", "example": null, "description": "If the agent/admin has an associated thumbnail picture, the URL to the file will be listed here." }, "brandId": { "type": "integer", "example": 1054, "description": "The CommBox account number associated with this agent/admin" }, "permissionId": { "type": "integer", "example": 3, "description": "Admins will have 3. Agents may have any other number (usually 2)" }, "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Smith" }, "email": { "type": "string", "example": "john.s@gmail.com" }, "userName": { "type": "string", "example": "john.s" }, "teamId": { "type": "integer", "example": 431, "description": "Lists the teams’ Id associated with the agent/admin" }, "teamName": { "type": "string", "example": "VIP" }, "profiles": { "type": "string", "example": "", "description": "List profiles Id associated with the agent/admin" }, "maxSyncObjectsAssignments": { "type": "integer", "example": 3, "description": "States the maximum number of Synchronous conversations the agent allows to have (Admins or agents without limitations will be null). Edit in the Auto Assignment module or in the Status tab of the Users page." }, "maxAsyncObjectsAssignments": { "type": "integer", "description": "States the maximum number of Asynchronous conversations the agent allows to have (Admins or agents without limitations will be null). Edit in the Auto Assignment module or in the Status tab of the Users page.", "example": 5 }, "multiReplyAccess": { "type": "string", "description": "Related to profiles", "example": "" } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } }, "post": { "tags": [ "Managers" ], "summary": "Update Manager", "operationId": "Update_Manager", "parameters": [ { "name": "MANAGER_ID", "in": "path", "description": "Manager ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/MANAGER_ID" } } ], "requestBody": { "description": "Optional description for new mail object in *Markdown*", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Manager" }, "example": { "data": { "FirstName": "John", "LastName": "Doe", "IsAdmin": false, "Password": "somepassword", "UserName": "John.d", "TeamId": 12, "PermissionId": 2 } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "OK" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "id": { "type": "integer", "example": 294159 } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } }, "delete": { "tags": [ "Managers" ], "summary": "Delete Manager", "description": "This API deletes agents/admins from the system based on their Agent/Admin Id (Manager_Id).", "operationId": "Delete_Manager", "parameters": [ { "name": "MANAGER_ID", "in": "path", "description": "Manager ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/MANAGER_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "id": { "type": "integer", "example": 520760 } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/managers": { "get": { "tags": [ "Managers" ], "summary": "Get Managers", "description": "This API returns a list of all agents and admins related to the account.
It sends a URL (The specific account Id will be the authentication params) and returns a list of agents/admin found in the account.", "operationId": "Get_Managers", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "description": "The agent’s or admin’s Id number", "example": 520760 }, "identityId": { "type": "integer", "description": "CommBox associates conversations with a customer via a specified communication channel. A customer may have a few identities when the conversations use more than one communication channel. For agents/admins, this number is irrelevant and just identifies the user as a manager.", "example": "2192427" }, "streamProviderId": { "type": "string", "description": "Access point – usually the email", "example": "john.s@gmail.com" }, "thumbnailUrl": { "description": "If the agent/admin has an associated thumbnail picture, the URL to the file will be listed here.", "type": "string", "example": null }, "brandId": { "type": "integer", "description": "The business account number in CommBox", "example": 223221 }, "permissionId": { "type": "integer", "example": 3 }, "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Smith" }, "email": { "type": "string", "example": "john.s@gmail.com" }, "userName": { "type": "string", "example": "john.s" }, "team": { "type": "integer", "description": "List all teams associated with this agents", "example": "2343,2445,4342" }, "teamId": { "type": "integer", "description": "Id of the first team this agent belonged to", "example": 2343 }, "teamName": { "type": "string", "description": "The name of the first listed team", "example": "VIP" }, "profiles": { "type": "string", "description": "Profiles Id(s) associated with this agent.", "example": "234355,24566" }, "maxSyncObjectsAssignments": { "type": "integer", "example": 3 }, "maxAsyncObjectsAssignments": { "type": "integer", "example": 5 } } }, { "type": "object", "properties": { "id": { "type": "integer", "example": 520761 }, "identityId": { "type": "integer", "example": "2192428" }, "streamProviderId": { "type": "string", "example": "john.d@gmail.com" }, "thumbnailUrl": { "type": "string", "example": null }, "brandId": { "type": "integer", "example": 2 }, "permissionId": { "type": "integer", "example": 3 }, "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Doe" }, "email": { "type": "string", "example": "john.d@gmail.com" }, "userName": { "type": "string", "example": "john.d" }, "teamId": { "type": "integer", "example": 0 }, "teamName": { "type": "string", "example": "" }, "profiles": { "type": "string", "example": "" }, "maxSyncObjectsAssignments": { "type": "integer", "example": 2 }, "maxAsyncObjectsAssignments": { "type": "integer", "example": 4 } } } ] } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } }, "post": { "tags": [ "Managers" ], "summary": "Create Manager", "description": "This API creates a new agent or an admin in the system.
Required parameters include the full name, email address, and initial password.
Body params must also include if the new entity is an admin (IsAdmin Boolean is true) or an agent (IsAdmin Boolean is false).
Add the team Id and profile Id for the new agent (optional).
API returns a user Id.", "operationId": "Create_Manager", "requestBody": { "description": "Optional description for new mail object in *Markdown*", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Manager" }, "example": { "data": { "FirstName": "John", "LastName": "Doe", "Email": "John.d@gmail.com", "IsAdmin": false, "Password": "somepassword", "UserName": "John.d", "TeamId": 12, "PermissionId": 2 } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "OK" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "id": { "type": "integer", "example": 294159 } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/managers/profiles/{PROFILE_ID}": { "get": { "tags": [ "Profiles" ], "summary": "Get Managers By Profile ID", "description": "This API returns a list of all the agents that share the specified Profile Id.", "operationId": "Get_manager_by_profile_id", "parameters": [ { "name": "PROFILE_ID", "in": "path", "description": "Profile ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/PROFILE_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "Id": { "type": "integer", "example": 520760 }, "FirstName": { "type": "string", "example": "John" }, "LastName": { "type": "string", "example": "smith" }, "Permission": { "type": "integer", "example": 2 }, "Email": { "type": "string", "example": "john.s@gmail.com" }, "UserName": { "type": "string", "example": "john.s" }, "TeamId": { "type": "integer", "example": 0 } } }, { "type": "object", "properties": { "Id": { "type": "integer", "example": 520761 }, "FirstName": { "type": "string", "example": "John" }, "LastName": { "type": "string", "example": "Doe" }, "Permission": { "type": "integer", "example": 2 }, "Email": { "type": "string", "example": "john.d@gmail.com" }, "UserName": { "type": "string", "example": "john.d" }, "TeamId": { "type": "integer", "example": 0 } } } ] } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/managers/teams/{TEAM_ID}": { "get": { "tags": [ "Teams" ], "summary": "Get Team Members", "description": "This API returns a list of all agents and team leaders associated with a specific team.
Team Id is a required path parameter.", "operationId": "Get_manager_by_team_id", "parameters": [ { "name": "TEAM_ID", "in": "path", "description": "Team ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/TEAM_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "Id": { "type": "integer", "example": 520760 }, "FirstName": { "type": "string", "example": "John" }, "LastName": { "type": "string", "example": "smith" }, "Permission": { "type": "integer", "example": 2 }, "Email": { "type": "string", "example": "john.s@gmail.com" }, "UserName": { "type": "string", "example": "john.s" }, "TeamId": { "type": "integer", "example": 5 } } }, { "type": "object", "properties": { "Id": { "type": "integer", "example": 520761 }, "FirstName": { "type": "string", "example": "John" }, "LastName": { "type": "string", "example": "Doe" }, "Permission": { "type": "integer", "example": 2 }, "Email": { "type": "string", "example": "john.d@gmail.com" }, "UserName": { "type": "string", "example": "john.d" }, "TeamId": { "type": "integer", "example": 5 } } } ] } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } }, "post": { "tags": [ "Teams" ], "summary": "Update Team by Team Id", "description": "Update team by given parameters", "operationId": "Update_team_by_team_id", "parameters": [ { "name": "TEAM_ID", "in": "path", "description": "Team ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/TEAM_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "string", "example": "" } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } }, "delete": { "tags": [ "Teams" ], "summary": "Delete a Team", "description": "This API deletes a team based on the Team Id (required Parameter).", "operationId": "Delete_team_by_team_id", "parameters": [ { "name": "TEAM_ID", "in": "path", "description": "Team ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/TEAM_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "string", "example": "" } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/managers/{MANAGER_ID}/presence": { "get": { "tags": [ "Presence" ], "summary": "Get Manager Presence", "description": "This API returns the Presence status(es) of a specific agent.
The Manager (agent) Id is a required path parameter.", "operationId": "Get_Manager_presence", "parameters": [ { "name": "MANAGER_ID", "in": "path", "description": "Manager ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/MANAGER_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "presence_type": { "type": "integer", "example": 1 }, "type_id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Active" } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/managers/{MANAGER_ID}/presence/{ACTIVITY_ID}": { "post": { "tags": [ "Presence" ], "summary": "Update Manager Presence", "description": "Update manager presence activity id", "operationId": "Update_Manager_presence", "parameters": [ { "name": "MANAGER_ID", "in": "path", "description": "Manager ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/MANAGER_ID" } }, { "name": "ACTIVITY_ID", "in": "path", "description": "Valid ACTIVITY_ID", "required": true, "schema": { "$ref": "#/components/parameters/ACTIVITY_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "presence_type": { "type": "integer", "example": 1 }, "type_id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Active" } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/managers/presence": { "get": { "tags": [ "Presence" ], "summary": "Get Presence Types", "description": "This API returns a list of presence Ids, names, and types within the system.", "operationId": "Get_presence_types", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Active" }, "presenceType": { "type": "integer", "example": 1 } } }, { "type": "object", "properties": { "id": { "type": "integer", "example": 2 }, "name": { "type": "string", "example": "Busy" }, "presenceType": { "type": "integer", "example": 2 } } } ] } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/managers/profiles": { "get": { "tags": [ "Profiles" ], "summary": "Get Profiles", "description": "A profile is a set of permissions the agent has access to.
This API returns a list of all agents’ profile Ids and profile names.
API Returns
\"Id\" refers to the profile Id number
\"Name\" is the name of the profile
\"UniqueName\" is a secondary name (optional)", "operationId": "Get_profiles", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "test" }, "UniqueName": { "type": "string", "example": "unique test" } } }, { "type": "object", "properties": { "id": { "type": "integer", "example": 2 }, "name": { "type": "string", "example": "test 2" }, "UniqueName": { "type": "string", "example": "unique test 2" } } } ] } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/managers/{MANAGER_ID}/profiles": { "delete": { "tags": [ "Profiles" ], "summary": "Remove All Agent Profiles", "description": "This API removes all profiles from a specific agent/admin.
The agent Id is a required path parameter. You can obtain a list of agent Ids from the Get Manager API.", "operationId": "Remove_All_Manager_Profiles", "parameters": [ { "name": "MANAGER_ID", "in": "path", "description": "Manager Id is a CommBox generated number for the agent Id.", "required": true, "schema": { "$ref": "#/components/parameters/MANAGER_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "string", "example": "" } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } }, "post": { "tags": [ "Profiles" ], "summary": "Add Profiles", "description": "This API Adds or changes the profiles of a specific agent/admin.
The Manager Id of the agent is required, as well as the specific profile Id or name.
To Add profiles, set the Query parameter to “add” and enter the profile’s name or Id. Separate multiple profiles with a comma.
To Change profiles (delete the current and add the new), set the Query parameter to “set” and enter the profile’s name or Id. Separate multiple profiles with a comma.
Note that only one query parameter should be used – not both.
API Sends URL + Manager’s Id q=[profile id]", "operationId": "Add_Profiles", "parameters": [ { "name": "MANAGER_ID", "in": "path", "description": "Manager ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/MANAGER_ID" } }, { "name": "add", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "minItems": 1 }, "style": "form", "explode": false }, { "name": "set", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "minItems": 1 }, "style": "form", "explode": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "test" }, "UniqueName": { "type": "string", "example": "unique test" } } }, { "type": "object", "properties": { "id": { "type": "integer", "example": 2 }, "name": { "type": "string", "example": "test 2" }, "UniqueName": { "type": "string", "example": "unique test 2" } } } ] } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/managers/{MANAGER_ID}/profiles/{PROFILE_ID}": { "delete": { "tags": [ "Profiles" ], "summary": "Delete Manager Profile", "description": "This API removes a specific profile from a specific agent/admin.
The agent Id and profile Id are required path parameters. You can obtain a list of agent Ids from the Get Manager API and a list of profiles from the Get Profile API.", "operationId": "Delete_Manager_Profile", "parameters": [ { "name": "MANAGER_ID", "in": "path", "description": "Manager ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/MANAGER_ID" } }, { "name": "PROFILE_ID", "in": "path", "description": "Profile ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/PROFILE_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "string", "example": "" } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/managers/{MANAGER_ID}/assignments": { "get": { "tags": [ "Assignments" ], "summary": "Get Manager Assignments", "description": "This API returns a list of assigned conversations to a specific agent/admin.
Manager (agent) Id is a required path parameter.
Data includes the communication channel type (see Enum) and its unique name.", "operationId": "Get_Manager_Assignments", "parameters": [ { "name": "MANAGER_ID", "in": "path", "description": "Manager ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/MANAGER_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "AssignedObjectsCount": { "type": "integer", "example": 1 }, "StreamTypeId": { "type": "integer", "example": 3 }, "ModuleId": { "type": "integer", "example": 3 }, "ModuleUniqueName": { "type": "string", "example": "facebook_page_connector" } } }, { "type": "object", "properties": { "AssignedObjectsCount": { "type": "integer", "example": 2 }, "StreamTypeId": { "type": "integer", "example": 10 }, "ModuleId": { "type": "integer", "example": 6 }, "ModuleUniqueName": { "type": "string", "example": "mailbox_connector" } } }, { "type": "object", "properties": { "AssignedObjectsCount": { "type": "integer", "example": 65 }, "StreamTypeId": { "type": "integer", "example": 20 }, "ModuleId": { "type": "integer", "example": 26 }, "ModuleUniqueName": { "type": "string", "example": "webrtc_video_chat" } } } ] } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } }, "post": { "tags": [ "Assignments" ], "summary": "Assign Manager", "description": "This API assigns a conversation to a specific agent.
Manager (agent) Id is a required path parameter, and the Object (conversation) Id is a required query parameter. Example https://api.commbox.io/managers/{MANAGER_ID}/assignments?objectId={OBJECT_ID}", "operationId": "Assign_Manager", "parameters": [ { "name": "MANAGER_ID", "in": "path", "description": "Valid MANAGER_ID", "required": true, "schema": { "$ref": "#/components/parameters/MANAGER_ID" } }, { "name": "objectId", "in": "query", "description": "objectId", "required": true, "schema": { "$ref": "#/components/parameters/OBJECT_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "string", "example": null } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } }, "delete": { "tags": [ "Assignments" ], "summary": "Unassign Manager", "description": "This API unassigns a conversation to a specific agent.
Manager (agent)Id is a required path parameter, and the Object (conversation) Id is a required query parameter. Example https://api.commbox.io/managers/{MANAGER_ID}/assignments?objectId={OBJECT_ID}", "operationId": "Unassign_Manager", "parameters": [ { "name": "MANAGER_ID", "in": "path", "description": "Valid MANAGER_ID", "required": true, "schema": { "$ref": "#/components/parameters/MANAGER_ID" } }, { "name": "objectId", "in": "query", "description": "objectId", "required": true, "schema": { "$ref": "#/components/parameters/OBJECT_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "string", "example": null } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/stats/streams": { "get": { "tags": [ "Streams" ], "summary": "Get Streams Stats", "description": "returns the current object statuses in all streams for the requested brand", "operationId": "Get_streams_stats", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "moduleId": { "type": "integer", "example": 1 }, "streamId": { "type": "integer", "example": 1 }, "subStreamId": { "type": "integer", "example": 0 }, "statusId": { "type": "integer", "example": 1 }, "c": { "type": "integer", "example": 93 } } }, { "type": "object", "properties": { "moduleId": { "type": "integer", "example": 3 }, "streamId": { "type": "integer", "example": 18 }, "subStreamId": { "type": "integer", "example": 25 }, "statusId": { "type": "integer", "example": 1 }, "c": { "type": "integer", "example": 28 } } } ] } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/stats/streamsSLAExceptions": { "get": { "tags": [ "Streams" ], "summary": "Get SLA Breach Summary", "description": "A service-level agreement (SLA) defines the service standards the provider is obligated to provide to the customer. The First Response time to the customer’s inquiry is an example of a typical SLA measured by CommBox. After that time passes, the SLA is breached.
There are 2 SLA Warnings that can be set in the SLA settings page:
- A warning is activated after 50% (default settings) of the time allotted by the SLA past.
- A critical warning is activated when there is only 20% (default settings) of the time left before an SLA breach.
(For example, if the Service Level Agreement is 5 minutes, conversations waiting for the First Response will be painted in orange after 2.5 minutes and in red after 4 minutes.)
This API returns the number of SLA breaches for the entire account divided by communication channel Id, longest conversations, and specific agent/bot SLA.
Note:“Exceptions” refers to Breaches, and “SlaCritical” refers to the SLA critical warning.", "operationId": "Get_SLA_streams_stats", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "items": { "oneOf": [ { "type": "object", "properties": { "Item1": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "moduleId": { "type": "integer", "example": 3 }, "streamId": { "type": "integer", "example": 18 }, "subStreamId": { "type": "integer", "example": 25 }, "statusId": { "type": "integer", "example": 1 }, "c": { "type": "integer", "example": 28 } } }, { "type": "object", "properties": { "moduleId": { "type": "integer", "example": 3 }, "streamId": { "type": "integer", "example": 18 }, "subStreamId": { "type": "integer", "example": 25 }, "statusId": { "type": "integer", "example": 1 }, "c": { "type": "integer", "example": 28 } } } ] } } } }, { "type": "object", "properties": { "Item2": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "moduleId": { "type": "integer", "example": 3 }, "streamId": { "type": "integer", "example": 18 }, "subStreamId": { "type": "integer", "example": 25 }, "statusId": { "type": "integer", "example": 1 }, "c": { "type": "integer", "example": 28 } } }, { "type": "object", "properties": { "moduleId": { "type": "integer", "example": 3 }, "streamId": { "type": "integer", "example": 18 }, "subStreamId": { "type": "integer", "example": 25 }, "statusId": { "type": "integer", "example": 1 }, "c": { "type": "integer", "example": 28 } } } ] } } } } ] } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/managers/teams": { "get": { "tags": [ "Teams" ], "summary": "Get All Teams", "description": "This API lists all the Teams Ids and their names for the account.", "operationId": "Get_Team", "parameters": [ { "name": "Name", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "OK" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "teamId": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "test" } } }, { "type": "object", "properties": { "teamId": { "type": "integer", "example": 2 }, "name": { "type": "string", "example": "test 2" } } } ] } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } }, "post": { "tags": [ "Teams" ], "summary": "Create a Team", "description": "This API is used to create a new Team.
Enter the new Team’s name in the query parameter.
The API returns a new Team Id number.", "operationId": "Create_Team", "parameters": [ { "name": "Name", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "OK" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "id": { "type": "integer", "example": 21221 } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/sms/sendinitialtext/{ENCRYPTED_STREAM_ID}/{PHONE_NUMBER}": { "post": { "tags": [ "SMS" ], "summary": "Send Initial Text/SMS", "description": "send the initial conversation text message to the user", "operationId": "Send_initial_text_SMS", "parameters": [ { "name": "ENCRYPTED_STREAM_ID", "in": "path", "description": "ENCRYPTED STREAM ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/ENCRYPTED_STREAM_ID" } }, { "name": "PHONE_NUMBER", "in": "path", "description": "Valid PHONE_NUMBER", "required": true, "schema": { "$ref": "#/components/parameters/PHONE_NUMBER" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "string", "example": "" } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/sms/sendsms/{ENCRYPTED_STREAM_ID}": { "post": { "tags": [ "SMS" ], "summary": "Send SMS", "description": "Send SMS", "operationId": "Send_SMS", "parameters": [ { "name": "ENCRYPTED_STREAM_ID", "in": "path", "description": "ENCRYPTED STREAM ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/ENCRYPTED_STREAM_ID" } } ], "requestBody": { "description": "Optional description for new mail object in *Markdown*", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "Number": { "type": "string", "example": "9725051234567" }, "Message": { "type": "string", "example": "message text" } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "string", "example": "" } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/v2/whatsapp/sendtemplatedmessage/{ENCRYPTED_STREAM_ID}": { "post": { "tags": [ "WhatsApp" ], "summary": "Send WhatsApp Templated Message V2", "description": "\n\n This API sends a generated WhatsApp template from the **WhatsApp Business Account** (WABA) to a single recipient or to multiple recipients (up to 20).
\n **Key New Capabilities of V2 version**
\nMarketing and Utility Templates may have a header with text or added media (attached document, image, or video), a footer, and a call for action or quick reply buttons.
The API can also create CommBox object(s), support Subchannels, and enable scheduled publishing.
\n\n **Send Templated Message + Object data**
\n Sending any templated WhatsApp message with Object data also creates a conversation (Object) on the CommBox platform.
The required and optional fields are described here: https://www.commbox.io/api/#operation/Create_Object\n\n
**Send Templated Message with an Attached File**
\n There are two ways to do so: \n\n
\n OR
\n\n
**Authentication Templates**
\n\n See the Examples for sending an authentication template.
For more information:\n
\n
After the customer opts in, use the contacts node to validate the registered number.
For more information, visit:
Note: Checking too many phone numbers without sending them messages will lead to WA banning you.
Only verify phone numbers critical to your business that you have already received opt-in for.", "operationId": "Validate_WhatsApp_Acoount", "parameters": [ { "name": "ENCRYPTED_STREAM_ID", "in": "path", "description": "ENCRYPTED STREAM ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/ENCRYPTED_STREAM_ID" } }, { "name": "PHONE_NUMBER", "in": "path", "description": "Valid PHONE_NUMBER", "required": true, "schema": { "$ref": "#/components/parameters/PHONE_NUMBER" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "valid": { "type": "boolean", "example": true } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/tags": { "get": { "tags": [ "Tags" ], "summary": "Get Tags", "description": "This API returns a list of all Tags in the account/brand as recognized by the authentication.
Data includes the tag's Id number, name (identity id), and type (as a code). A listing of Tag types is found in the Enum section in the Getting Started section.
", "operationId": "get_tags", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "example": 1 }, "identityId": { "type": "string", "example": "test" }, "streamProviderId": { "type": "string", "example": null } } }, { "type": "object", "properties": { "id": { "type": "integer", "example": 2 }, "identityId": { "type": "string", "example": "test2" }, "streamProviderId": { "type": "string", "example": null } } } ] } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } }, "post": { "tags": [ "Tags" ], "summary": "Create a Tag", "description": "This API creates a new tag, where the name/content of the tag is part of the body parameters.
If you want this new tag to be part of a group of tags, you’ll need to place the group Id in the TagGroupId field.
Tags can be attached to a conversation (object), to a specific comment or a reply (child), or to a customer (user). Set the tag’s attachment options in the boolean parameters (true/false)
The API returns Tag Id.", "operationId": "Create_tag", "requestBody": { "description": "Optional description for new mail object in *Markdown*", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "Name": { "type": "string" }, "TagGroupId": { "type": "integer", "format": "int64" }, "ObjectTag": { "type": "boolean", "example": true }, "UserTag": { "type": "boolean", "example": false }, "ChildTag": { "type": "boolean", "example": false } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "id": { "type": "string", "example": 21221 } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters may not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/tags/{TAG_ID}": { "post": { "tags": [ "Tags" ], "summary": "Updating a Tag", "description": "This API updates/changes the name/content of a tag.
The tag’s Id is required as part of the URL. The actual changes to the tag are part of the Body Params - the new name/content and the associated group (optional).
", "operationId": "Update_tag", "parameters": [ { "name": "TAG_ID", "in": "path", "description": "Tag ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/TAG_ID" } } ], "requestBody": { "description": "Optional description for new mail object in *Markdown*", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "Name": { "type": "string", "example": "TAG Name" }, "Tag Group Id": { "type": "integer", "format": "int64", "example": 123 } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "id": { "type": "string", "example": null } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } }, "delete": { "tags": [ "Tags" ], "summary": "Delete a Tag", "description": "This API deletes a tag.
The tag’s Id is required as part of the URL.
Obtain a list of tags and their Ids with [GET] Get Tags - https://api.commbox.io/tags", "operationId": "Delete_tag", "parameters": [ { "name": "TAG_ID", "in": "path", "description": "Tag Id is a CommBox unique identifier.", "required": true, "schema": { "$ref": "#/components/parameters/TAG_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "id": { "type": "string", "example": null } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/tags/groups": { "get": { "tags": [ "Tags" ], "summary": "Get Tags Group", "description": "A few tags with similar purposes, or originating teams, can be grouped together by the organization.
This API lists all the Tags Groups in the account. The API does not list the specific tags within each group.", "operationId": "Get_Tags_Group", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "test" }, "brandId": { "type": "string", "example": 1 } } }, { "type": "object", "properties": { "id": { "type": "integer", "example": 2 }, "name": { "type": "string", "example": "test2" }, "brandId": { "type": "string", "example": 1 } } } ] } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } }, "post": { "tags": [ "Tags" ], "summary": "Create Tags Group", "description": "A few tags with similar purposes or originating teams can be grouped together by the organization.
This API creates the name of the group of tags and returns a Tags Group Id.
To add tags to this new group, use the **Create Tag API** or the **Update Tag API**.", "operationId": "Create_Tags_Group", "requestBody": { "description": "Optional description for new mail object in *Markdown*", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "Name": { "type": "string", "example": "Group's name" } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "id": { "type": "string", "example": 21221 } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/tags/groups/{TAGS_GROUP_ID}": { "post": { "tags": [ "Tags" ], "summary": "Update Tags Group", "description": "A few tags with similar purposes or originating team can be grouped together by the organization.
This API lets you change the name of such a group of tags.
All the tags associated with the old name of the tags group will now be associated with the new name.
The Tags Group Id is required.
\nTo add a specific tag to the new group, use the **Update Tag API** (Tag’s Id required).
To delete a specific tag from the new group, use the **Delete Tag API** (Tag’s Id required).
", "operationId": "Update_tags_group", "parameters": [ { "name": "TAGS_GROUP_ID", "in": "path", "description": "Tags Group Id. is a CommBox unique identifier", "required": true, "schema": { "$ref": "#/components/parameters/TAGS_GROUP_ID" } } ], "requestBody": { "description": "Optional description for new mail object in *Markdown*", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "Name": { "type": "string", "example": "TAG's Name" } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "id": { "type": "string", "example": null } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } }, "delete": { "tags": [ "Tags" ], "summary": "Delete a Tags group", "description": "This API deletes a Tags Group - Group ID is required.
Use the **Get Tags Group** API to obtain a list of tags group names and their Id.
**Note:** Deleting a group of tags will delete all tags included in that group.", "operationId": "Delete_tags_group", "parameters": [ { "name": "TAGS_GROUP_ID", "in": "path", "description": "TAGS_GROUP_ID", "required": true, "schema": { "$ref": "#/components/parameters/TAGS_GROUP_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "id": { "type": "string", "example": null } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/forms/createlink/{FORM_ID}": { "post": { "tags": [ "Forms" ], "summary": "Get New Form Link", "description": "### Parameters\nForm ID – Form number (as seen in the forms list screen).Data – A Json string consists of the following fields:
- streamProviderId – Customer phone number or email (which will be receiving the form)
- streamProviderType – Identifies which type of value (phone or email) the streamProviderId contains, 4 is email, 5 is phone number.
- referringObjectId (optional) – When the form link is opened a new form object is created in the system, this object can be linked to another object, for example a chat conversation, so once the form is filled by the customer you will see (in the manage system) the chat conversation with an indicator of the filled form.
- properties (optional) – a Json string contains initial values for the form fields, so when the customer will open the form its fields will contain those values.
This API returns a session cookie that is added to login URL to bypasses the username and password screen.
Format: Login URL + the characters ?=TA + the session cookie returned by the API
Example: https://bumpyard.commbox.io/login?=TAhZ8uTCLgf1HnOwVy_bIEWVJD0VXnIcbMKTT9R6_bW0prs_fYgzbzQCRMpdPZw1FopLHoGJG0VUDFk3zYEfkG_fEf9hnk50lR72BZHp7X_f94jZQbJNP4ysWmRJ3Lqc
Managers who wish to gain access to CommBox via the authentication ticket, must be set as users in each account (brand).
Note:
a) Mandatory fields include the business account name (brand), and all fields which are mandatory when creating a user for that brand (For example, FirstName, LastName, Phone, email address, etc.). System will return the cookie if there is a match in the database with all mandatory fields.
b) Most params are of the String type, including the phone number. This is designed to accommodate standard records like +44 for country code, or 212-123-4567 for area code format. Make sure to add “ “ around the phone number as well.
c) Once created, tickets are only valid for 60 seconds for the management system and 5 minutes for other applications. ", "operationId": "Create_Ticket", "requestBody": { "description": "Optional description for new mail object in *Markdown*", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "brand": { "type": "string", "example": "commbox" }, "username": { "type": "string", "example": "john.d" }, "email": { "type": "string", "example": "john.d@gmail.com" }, "uniqueId": { "type": "string", "example": 123456 }, "firstName": { "type": "string", "example": "john" }, "lastName": { "type": "string", "example": "Doe" }, "phone1": { "type": "string", "example": 972501234567 }, "remark": { "type": "string", "example": "this is a remark" }, "overrideUserInfo": { "type": "boolean", "example": true } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "encpryptedString": { "type": "string", "example": "hZ8uTCLgf1HnOwVy_bIEWVJD0VXnIcbMKTT9R6_bW0prs_fYgzbzQCRMpdPZw1FopLHoGJG0VUDFk3zYEfkG_fEf9hnk50lR72BZHp7X_f94jZQbJNP4ysWmRJ3Lq9Q245j3D" } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/automation/objects/{OBJECT_ID}/context": { "get": { "tags": [ "Automation" ], "summary": "Get Object Context", "description": "Returns object data context. Must include desierd data propertie for query (comma separated) Example https://api.commbox.io/automation/objects/{OBJECT_ID}/context?properties=data.plus,data.name", "operationId": "Get_Object_Context", "parameters": [ { "name": "OBJECT_ID", "in": "path", "required": true, "schema": { "$ref": "#/components/parameters/OBJECT_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "data.plus": { "type": "string", "example": "4" } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } }, "post": { "tags": [ "Automation" ], "summary": "Insert Data Context", "description": "Insert data context to conversation", "operationId": "Insert_Data_Context", "parameters": [ { "name": "OBJECT_ID", "in": "path", "description": "Object ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/OBJECT_ID" } } ], "requestBody": { "description": "Optional description for new mail object in *Markdown*", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "properties": { "type": "object", "properties": { "plus": { "type": "integer", "example": 3 }, "name": { "type": "string", "example": "John" } } } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "id": { "type": "string", "example": 21221 } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } }, "/automation/objects/{OBJECT_ID}/context/jump": { "post": { "tags": [ "Automation" ], "summary": "Jump to node", "description": "Jump to node", "operationId": "JUMP_TO_NODE", "parameters": [ { "name": "OBJECT_ID", "in": "path", "description": "OBJECT ID. This is a commbox generated number", "required": true, "schema": { "$ref": "#/components/parameters/OBJECT_ID" } } ], "requestBody": { "description": "Optional description for new mail object in *Markdown*", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "address": { "type": "string", "example": "4079:n_8" } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": 200 }, "description": { "type": "string", "example": "Operation successful" }, "response_time": { "type": "string", "example": "2014-08-06T07:51:52.2581942Z" }, "data": { "type": "object", "properties": { "id": { "type": "string", "example": null } } } } } } } }, "400": { "description": "Bad Request - The request could not be understood by the server. Incoming parameters might not be valid" }, "401": { "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource" }, "404": { "description": "Not found - The requested resource is not found" }, "429": { "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)" }, "500": { "description": "Server Error - The server could not return the representation due to an internal server error" }, "501": { "description": "Not Implemented - The requested operation is not supported" } } } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "API key is needed to authorize requests. You can get your API key via the management console. A Bearer Token is needed to be set in the Authorization header of every API call. For additional support you can contact us." } }, "parameters": { "STREAM_ID": { "name": "STREAM_ID", "in": "query", "description": "Stream ID", "schema": { "type": "integer", "format": "int64" } }, "OBJECT_ID": { "name": "OBJECT_ID", "in": "query", "description": "OBJECT ID", "schema": { "type": "integer", "format": "int64", "description": "Object ID. This is a commbox generated number" } }, "STATUS_ID": { "name": "STATUS_ID", "in": "query", "description": "STATUS ID", "schema": { "type": "integer" } }, "USER_ID": { "name": "USER_ID", "in": "query", "description": "USER ID", "schema": { "type": "integer", "format": "int64" } }, "TAG_ID": { "name": "TAG_ID", "in": "query", "description": "TAG ID", "schema": { "type": "integer", "format": "int64" } }, "TAGS_GROUP_ID": { "name": "TAGS_GROUP_ID", "in": "query", "description": "TAGS GROUP ID", "schema": { "type": "integer", "format": "int64" } }, "INDICATOR_ID": { "name": "INDICATOR_ID", "in": "query", "description": "Custom indicator Id", "schema": { "type": "integer", "format": "int64" } }, "MANAGER_ID": { "name": "MANAGER_ID", "in": "query", "description": "Manager Id", "schema": { "type": "integer", "format": "int64" } }, "PROFILE_ID": { "name": "PROFILE_ID", "in": "query", "description": "Profile Id", "schema": { "type": "integer", "format": "int64" } }, "TEAM_ID": { "name": "TEAM_ID", "in": "query", "description": "Team Id", "schema": { "type": "integer", "format": "int64" } }, "ACTIVITY_ID": { "name": "ACTIVITY_ID", "in": "query", "description": "Activity Id", "schema": { "type": "integer", "format": "int64" } }, "FORM_ID": { "name": "FORM_ID", "in": "query", "description": "Form Id - Form number (as seen in the forms list screen)", "schema": { "type": "integer", "format": "int64" } }, "userIdentityId": { "name": "userIdentityId", "in": "query", "description": "Only return objects created by this user (optional)", "schema": { "type": "integer", "format": "int64" } }, "identityStreamProviderId": { "name": "identityStreamProviderId", "in": "query", "description": "Only return objects created by this user. Must supply identityStreamProviderId as well (optional)", "schema": { "type": "string" } }, "ENCRYPTED_STREAM_ID": { "name": "ENCRYPTED_STREAM_ID", "in": "query", "description": "The ENCRYPTED STREAM ID that was created by the system", "schema": { "type": "string" } }, "PHONE_NUMBER": { "name": "PHONE_NUMBER", "in": "query", "description": "Valid PHONE_NUMBER", "schema": { "type": "integer", "format": "int64" } }, "identityStreamProviderType": { "name": "identityStreamProviderType", "in": "query", "description": "Only return objects created by this user. Must supply identityStreamProviderType as well (optional)", "schema": { "type": "string", "format": "short" } }, "subStream": { "name": "subStream", "in": "query", "description": "The sub stream Id (subchannel) of the objects (Optional, default 0)", "schema": { "type": "integer", "format": "int64" } }, "sort": { "name": "sort", "in": "query", "description": "Sort of return objects (optional, default desc). Possible values: desc, asc", "schema": { "type": "string" } }, "order": { "name": "order", "in": "query", "description": "Order of return objects (optional, default createdtime). Possible values: createdtime, closedtime, prioritytime, updatedtime", "schema": { "type": "string" } }, "includeChilds": { "name": "includeChilds", "in": "query", "description": "Return objects with their childs (optional, default false)", "schema": { "type": "boolean" } }, "includeActivityLog": { "name": "includeActivityLog", "in": "query", "description": "Return objects with their activity log (optional, default false)", "schema": { "type": "boolean" } }, "timeFilter": { "name": "timeFilter", "in": "query", "description": "Determines according to which object datetime field affects unixStartTime & unixEndTime (optional, relevant only for ElasticSearch)", "schema": { "type": "string" } }, "pageNumber": { "name": "pageNumber", "in": "query", "description": "Used for paging results (optional)", "schema": { "type": "integer" } }, "pageSize": { "name": "pageSize", "in": "query", "description": "Used for paging results (optional, default 100)", "schema": { "type": "integer" } }, "status": { "name": "status", "in": "query", "description": "ObjectStatusType - see Enums for code.
Returned objects must have selected statuses in a comma separated list
(Optional, default all)", "schema": { "type": "string" } }, "unixStartTime": { "name": "unixStartTime", "in": "query", "description": "Unix time stamp (UTC) of object's created time start date (optional), must be sent with unixEndTime", "schema": { "type": "integer", "format": "int64" } }, "unixEndTime": { "name": "unixEndTime", "in": "query", "description": "Unix time stamp (UTC) of object's created time end date (optional), must be sent with unixStartTime", "schema": { "type": "integer", "format": "int64" } } }, "schemas": { "Object": { "type": "object", "properties": { "SubStreamId": { "type": "integer", "format": "int64", "description": "The subchannel ID of the conversation" }, "Type": { "type": "integer", "format": "int64", "description": "The type of object used (text, link, photo, etc.)- See Enum for code" }, "StatusId": { "type": "string", "description": "The conversation’s current state (Open, Resolved, etc.) – See Enum for code" }, "StreamProviderType": { "type": "integer", "format": "int64", "description": "Type of the object original stream provider" }, "StreamProviderId": { "type": "integer", "format": "int64", "description": "Generated guid chars" }, "UserStreamProviderId": { "type": "string", "description": "Identity’s unique identifier as it appears at the original provider" }, "UserStreamProviderType": { "type": "integer", "format": "int64", "description": "Type of the user original provider" }, "UserIdentity": { "type": "integer", "format": "int64", "description": "User identity id" }, "ManagerId": { "type": "integer", "format": "int64", "description": "The manager who create the object (optional)" }, "Content": { "type": "string", "format": "JSON string", "description": "String containing extended properties of the object" }, "Message": { "type": "string", "description": "(required) The text of the primary message. This is a mandatory/required field" }, "sendToClient": { "type": "boolean", "description": "If true - send message without saving it (relevant for SMS streams only)" }, "createChildObject": { "type": "boolean", "description": "If true - " }, "User": { "type": "object", "description": "The user that created the object" } } }, "Object_Child": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "type": { "type": "integer", "format": "int64", "description": "The type of the object" }, "IsManager": { "type": "boolean", "description": "Indicates whether this child was created by a manager" }, "CreatedTime": { "type": "string", "format": "datetime", "description": "When the child was created" }, "Message": { "type": "string", "description": "The text containing the child’s primary message" }, "Content": { "type": "string", "format": "JSON string", "description": "String containing extended properties of the child" }, "User": { "type": "object", "description": "The user that created the child" } } }, "ObjectActivityLog": { "type": "object", "properties": { "text": { "type": "string", "description": "Text content in the activity log" }, "Source": { "type": "string", "description": "The source of the activity log (optional)" }, "ManagerId": { "type": "integer", "format": "int64", "description": "The agent who initialize the activity log (optional)" } } }, "Tag": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Tag ID. This is a commbox generated number" } } }, "User": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "User ID. This is a commbox generated number" }, "UniqueId": { "type": "string", "format": "50", "description": "User’s unique identifier. This can be an email, social security number or any other type of unique string determined by the brand administrators" }, "Phone1": { "type": "string", "format": "numeric string (20)", "description": "User’s phone number (Always contains country code and without leading + or 00)" }, "Phone2": { "type": "string", "format": "numeric string (20)", "description": "User’s additional phone number (Always contains country code and without leading + or 00)" }, "Email": { "type": "string", "format": "255", "description": "User's Email." }, "FirstName": { "type": "string", "format": "100", "description": "User’s first name" }, "LastName": { "type": "string", "format": "100", "description": "User’s last name" }, "Gender": { "type": "string", "format": "1", "description": "User’s gender (‘M’ for male, ‘F’ for female)" }, "Locale": { "type": "object", "description": "User’s locale" }, "Birthday": { "type": "string", "format": "date", "description": "User’s birthday" }, "NumIdentities": { "type": "integer", "description": "Number of active identities that are connected to this user" }, "IsManager": { "type": "boolean", "description": "Indicates whether this user is a agent or an admin (true) or a customer (false)" }, "Remarks": { "type": "string", "description": "Free text containing general remarks about the user" }, "Identity": { "type": "object", "description": "Identity object that is connected to the user" } } }, "User_Short": { "type": "object", "properties": { "UniqueId": { "type": "string", "format": "50", "description": "User’s unique identifier. This can be an email, social security number or any other type of unique string determined by the brand administrators" }, "Email": { "type": "string", "format": "255", "description": "User's Email." }, "Phone1": { "type": "string", "format": "100", "description": "User’s main phone number" }, "Phone2": { "type": "string", "format": "100", "description": "User’s secondary phone number" }, "FirstName": { "type": "string", "format": "100", "description": "User’s first name" }, "LastName": { "type": "string", "format": "100", "description": "User’s last name" }, "Remarks": { "type": "string", "description": "Free text containing general remarks about the user" } } }, "User_Identity": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Identity ID. This is a commbox generated number and used throughout all the updates" }, "StreamProviderId": { "type": "string", "format": "255", "description": "Identity’s unique identifier as it appears at the original provider" }, "StreamProviderType": { "type": "integer", "format": "int64", "description": "Type of the original provider" }, "StreamProviderEmail": { "type": "string", "format": "255", "description": "Identity’s email as it appears at the original provider" }, "UserName": { "type": "string", "format": "100", "description": "Identity’s user name as it appears at the original provider" }, "FirstName": { "type": "string", "format": "100", "description": "Identity’s first name as it appears at the original provider" }, "LastName": { "type": "string", "format": "100", "description": "Identity’s last name as it appears at the original provider" }, "ThumbnailUrl": { "type": "string", "format": "255", "description": "Link to the identity’s profile image" }, "NumObjects": { "type": "integer", "description": "Number of objects connected to this identity" } } }, "Manager": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int64", "description": "Manager ID. This is a commbox generated number and used throughout all the updates" }, "AsyncAssignedNoResponse": { "type": "integer", "description": "Current number of assigned asynchronous objects awaiting response" }, "AsyncAssignedInProccess": { "type": "integer", "description": "Current number of assigned asynchronous objects that are being addressed by the manager" }, "SyncAssignedNoResponse": { "type": "integer", "description": "Current number of assigned synchronous objects awaiting response (Chat/messenger conversations)" }, "SyncAssignedInProccess": { "type": "integer", "description": "Current number of assigned synchronous objects that are being addressed by the manager (Chat/messenger conversations)" }, "FaceToFaceStatus": { "type": "boolean", "description": "Returns true if the manager is busy with a face to face object (Voice/Video call)" }, "TotalAsyncAssigned": { "type": "integer", "description": "Total number of currently assigned objects" }, "TotalSyncAssigned": { "type": "integer", "description": "Total number of currently assigned synchronous objects (Chat/messenger conversations)" } } }, "Object_custom_indicator": { "type": "object", "properties": { "IndicatorId": { "type": "string", "description": "Indicator id (unique name) – to allow updating/ deleting existing indicator" }, "DisplayClass": { "type": "string", "description": "Indicator class. Mandatory only if Icon has not provided" }, "Icon": { "type": "string", "description": "An icon for the indicator. Supports URL. Mandatory only if Icon has not provided (not relevant for DELETE operation)" }, "Title": { "type": "string", "description": "A title for the indicator (not relevant for DELETE operation)" }, "Link": { "type": "string", "description": "Optional link for the indicator (not relevant for DELETE operation)" } } }, "ObjectType": { "type": "string", "enum": [ "Text = 0", "Link = 1", "Photo = 2", "Video = 3", "Conversation = 4", "Mail = 5", "Audio = 6", "Location = 7", "Voice = 8", "Review = 9", "Form = 10", "System Message = 11", "Option = 12", "InputData = 13", "Contacts = 14", "Album = 15", "TemplateMessage = 16" ] }, "ObjectStatusType": { "type": "string", "enum": [ "Open = 1", "Resolved = 2", "Forward = 3", "Irrelevant = 4", "Deleted = 5", "Forward Reply = 6", "Draft = 7", "In Process = 8", "Scheduled = 9", "Follow Up = 10", "Automated = 11", "Sent = 13", "Archive = 14", "Pending = 15" ] }, "StreamProviderType": { "type": "string", "enum": [ "Commbox = 0", "Facebook = 1", "Twitter = 2", "YouTube = 3", "Mail = 4", "Telephone = 5", "Anonymous = 6", "WhatsApp = 7", "Web = 8", "AppleAppStore = 9", "Instagram= 10", "Google = 11", "Telegram= 12", "GoogleMyBusiness = 13", "Microsoft365 = 14", "Gmail = 15", "WhatsAppCloud = 16", "Salesforce = 17" ] }, "ObjectActivityType": { "type": "string", "enum": [ "Remark = 1", "StatusChange = 2", "Forward = 3", "ForwardReply = 4", "StreamChange = 5", "AssignChange = 6", "UpdateObjectTag = 7", "FollowUp = 8", "UpdateObjectIntent = 9", "Attachment = 10", "RuleExecuted = 11", "Custom = 12", "UpdateObjectPublicity = 13", "Debug = 14", "InvalidExtensionFile = 15", "InvalidFileSize = 16", "DisallowedFileUpload = 17", "InactivityLogout = 18", "ParticipantChange = 19", "TargetStreamChange = 20", "ConversationSummary = 21", "LogError = 22", "RedactChild = 23" ] }, "ModuleType": { "type": "string", "enum": [ "GENERAL = 0", "CUSTOMER_SERVICE = 1", "FACEBOOK_PAGE_CONNECTOR = 3", "STATIC_CONTENT = 4", "CONTEST = 5", "MAILBOX_CONNECTOR = 6", "YOUTUBE_CONNECTOR = 7", "TWITTER_CONNECTOR = 8", "CHAT = 9", "WEB_SYNDICATION_CONNECTOR = 10", "FACEBOOK_MONITOR_CONNECTOR = 11", "WHATSAPP = 13", "SMS = 14", "VOICE = 15", "SSO = 16,", "MANAGE_CLIENT_CUSTOMIZATIONS = 17", "APPLE_APPSTORE_REVIEWS = 18", "GOOGLE_PLAY_REVIEWS = 19", "INSTAGRAM_CONNECTOR = 20", "CONTACT_US = 21", "INTERACTIVE_NAVIGATOR = 25", "WEBRTC_VIDEO_CHAT = 26", "WEBRTC_AUDIO_CHAT = 27", "FORMS = 28", "CUSTOMER_VERIFICATION = 29", "DYNAMICS_CRM_CONNECTOR = 31", "CUSTOM_FIELDS = 32", "RIGHTNOW_CRM = 33", "RULES = 34", "EXTERNAL_CONTACTS = 35", "WORKING_HOURS = 36", "CUSTOM = 37", "FACEBOOK_MESSENGER = 38", "MAINTENANCE = 39", "PRIVACY_AND_SECURITY = 40", "AUTO_ASSIGN = 41", "TWO_FACTOR_AUTHENTICATION = 42", "THEMES = 43", "TELEGRAM = 44", "GOOGLE_MY_BUSINESS = 45", "SAP_CRM = 46", "SLA = 47", "PUSH_NOTIFICATIONS = 48", "SYS_AID = 49", "WORKFLOW = 50", "INSTAGRAM_DM = 52", "PRIORITY = 53", "JIRA = 54", "GOOGLE_BUSINESS_MESSAGES = 55", "BI_CUSTOM_REPORTS = 57", "SALESFORCE = 58", "AI_ASSISTANT = 59", "API = 60", "Zendesk = 61", "Teams = 65", "Hupspot = 71" ] } } } }