The Bright Pattern Contact Center Mobile/Web Messaging API v1 is a RESTful API that allows developers to integrate chat and voice interactions with mobile devices or third-party applications. This API can be used for development of rich contact applications, such as customer-facing mobile and web applications for advanced chat, voice, and video communications with Bright Pattern Contact Center-based contact centers.
\nThis documentation is intended for the IT personnel and developers of custom applications for Bright Pattern Contact Center-based contact centers. Readers of this documentation are expected to have expertise in web and mobile application development as well as a solid understanding of contact center operations and resources that are involved in such operations.
\nBright Pattern provides source code of sample customer-facing rich contact applications. This source code can be used as a reference for in-house application development or it can be embedded directly into the customer-facing mobile applications and/or web applications of your organization.
\nFor web chat applications, you can download the source code by clicking the Client application button on the Messaging/Chat Scenario Entry page of the Contact Center Administrator application.
\nFor mobile applications, you can obtain the source code by submitting a service request to Bright Pattern Customer Success Management.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Audience","slug":"audience"},{"content":"Sample Applications","slug":"sample-applications"}],"owner":"6735877","collectionId":"e2e0b1fb-f5e4-49e8-b500-a2a80074f660","publishedId":"T1LHGpBY","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-08-06T21:00:13.000Z"},"item":[{"name":"General Information","item":[],"id":"4e923b86-14fb-4e4e-8beb-184de7aacfea","description":"The following is an example of an API request:
\nURL: https://yourcontactcenter.brightpattern.com/clientweb/api/v1/chats?tenantUrl=yourcontactcenter.brightpattern.com\n\nMethod: POST\n\nAuthorization: MOBILE-API-140-327-PLAIN appId=\"test\", clientId=\"123\"\n\nContent-Type: application/json; charset=UTF-8\n\nUser-Agent: MobileClient\n\n{\n \"phone_number\":\"3001\",\n \"parameters\": {\n \"first_name\":\"John\",\n \"last_name\":\"Lee\"\n }\n}\nThe following elements are used for client authentication and must be specified in every client request:
\nStandard HTTP response codes whose meaning conforms to the original specification (RFC 2616) are not discussed in this document. For specification of such responses, see section 10 of http://www.ietf.org/rfc/rfc2616.txt. This document only specifies the response codes whose description deviates from the original specification (e.g., is defined more narrowly or has a different meaning).
\nNote that a client application can only have one active communication session at a time.
\nWhen the response status code indicates an error, a JSON response body is provided by the server to\ngive more details about the error:\n{\"error_code\": \"error code\", \"error_message\":\"error message\"}
\nHere is a list of the possible values of authorization-related error codes and error messages that are\ncommon to all requests that require authorization.
\nHere is a list of the possible values of other error codes and error messages.
\n","event":[{"listen":"prerequest","script":{"id":"54ba443f-cbf5-4147-9dab-ae82a573d594","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"64fa67e9-1954-40cd-a59d-166cf088b319","type":"text/javascript","exec":[""]}}],"_postman_id":"4e923b86-14fb-4e4e-8beb-184de7aacfea"},{"name":"Methods","item":[{"name":"Check Availability","id":"034a5daf-b092-41c3-a3ef-561ac2539f3d","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario.
\nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":"https://This method returns the availability status of the configured hours of operation of the associated Messaging/Chat scenario entry. Optionally, Estimated Wait time (EWT) (in seconds) may be returned but could be missing if the server does not have enough data to estimate the EWT value. Note that the API does not check if there are any agents actually logged in.
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":"https://This method returns an array of expected parameters. The parameters are optional. They may be used, for example, to look for the most qualified agents to handle the requested chat sessions and/or to display user information for the agents. These parameters are initially specified for the Messaging/Chat scenario entry through which this mobile application will communicate with the contact center.
\nCurrently, the following parameter types are supported:
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"This method initiates a chat session. It provides values of all or some of the expected parameters, and it may also contain the phone number of the mobile device. Depending on the scenario entry configuration, a callback can be initiated automatically to the specified number as soon as the chat request is delivered to the agent.
\nNotes:
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"This method returns the properties of an active chat session. Optionally, Estimated Wait time (EWT) (in seconds) may be returned but could be missing if the server does not have enough data to estimate the EWT value.
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"body":{"mode":"raw","raw":"{\r\n “events”: [This method sends events from the client to the server side.
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"The current chat session ID. The value of this variable is returned in the body of a successful invocation of the \"Request Chat\" method.
\n","type":"text/plain"},"type":"any","value":"","key":"chatId"}]}},"response":[{"id":"02a528a4-d89c-4705-9acf-1072a313bcd3","name":"Send Events Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":"https://This method returns all client events and all server events for the current session. Multiple event objects can be returned; each event's timestamp attribute can be used to restore the correct message order.
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"The current chat session ID. The value of this variable is returned in the body of a successful invocation of the \"Request Chat\" method.
\n","type":"text/plain"},"type":"any","value":"","key":"chatId"}]}},"response":[{"id":"05b44635-ac02-4421-81eb-8d8d6d658025","name":"Get Chat History Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\"","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":{"raw":"https://yourcompany.brightpattern.com/clientweb/api/v1/chats/:chatId/history?tenantUrl=yourcompany.brightpattern.com","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v1","chats",":chatId","history"],"query":[{"key":"tenantUrl","value":"yourcompany.brightpattern.com"}],"variable":[{"key":"chatId","value":"f5f68c35-ffec-4dcb-8f7f-755b6395a6dc"}]}},"code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"events\":[\r\n \"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"This method returns new chat events for the current session. If there are no new events, the server can keep the request active during a timeout (i.e., for about 5–15 seconds). If the client sends another request to get new events while the previous request is kept active, the server will respond with error 400 (Bad request).
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"The current chat session ID. The value of this variable is returned in the body of a successful invocation of the \"Request Chat\" method.
\n","type":"text/plain"},"type":"any","value":"","key":"chatId"}]}},"response":[{"id":"3c91960c-f89b-4985-9e6d-5d00aa7452ad","name":"Get New Chat Events Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"The file or text to be uploaded
\n","type":"file","src":"/C:/Users/Lenovo/Desktop/important_file.txt"}]},"url":"https://This method uploads a file to the server. The maximum file size is 25 MB. The server will store up to 1000 files. Newly received files will replace the oldest files. This method can be used, for example, to send pictures from the client mobile application to the contact center agents.
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"This method downloads a file from the server using the received file ID. See server event Chat Session File.
\nThe current chat session ID. The value of this variable is returned in the body of a successful invocation of the \"Request Chat\" method.
\n","type":"text/plain"},"type":"any","value":"","key":"chatId"},{"description":{"content":"The file ID of the file to download
\n","type":"text/plain"},"type":"any","value":"","key":"fileId"}]}},"response":[{"id":"01cb53de-53f1-4c01-b34b-84828769eae1","name":"Get File Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\""}],"url":{"raw":"https://yourcompany.brightpattern.com/clientweb/api/v1/chats/:chatId/files/:fileId","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v1","chats",":chatId","files",":fileId"],"query":[{"key":"","value":"","disabled":true},{"key":"","value":"","disabled":true}],"variable":[{"key":"chatId","value":"f5f68c35-ffec-4dcb-8f7f-755b6395a6dc"},{"key":"fileId","value":"e1f234c35-ffec-4dcb-8f7f-755b6395a6dc"}]}},"code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"File content type"}],"_postman_id":"55791b6d-fdbf-4fc1-8348-e843599df60d"},{"name":"Get Agent Profile Photo","id":"06901c0d-142b-44b2-a6b0-063609196a3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"This method downloads a profile photo of the specified agent.
\nThe request body is the party ID of the agent participating in the current chat session.
\nNote: The party ID is provided with the chat event (polled at https://{host:port}/clientweb/api/v1/chats/{chatId}/events?tenantUrl={tenantUrl}). For example, you can see party_ID in the event message for chat_session_party_joined.
\nThe current chat ID
\n","type":"text/plain"},"type":"any","value":"","key":"chatId"},{"description":{"content":"The party ID of the agent for the current chat session
\n","type":"text/plain"},"type":"any","value":"","key":"partyId"}]}},"response":[{"id":"a966188d-4adf-463b-8b27-76bb700529d8","name":"Get Agent Profile Photo Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\""}],"url":{"raw":"https://yourcompany.brightpattern.com/clientweb/api/v1/chats/:chatId/profilephotos/:partyId","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v1","chats",":chatId","profilephotos",":partyId"],"variable":[{"key":"chatId","value":"f5f68c35-ffec-4dcb-8f7f-755b6395a6dc"},{"key":"partyId","value":"e5f23c35-ffec-4dcb-8f7f-755b6395a6dd"}]}},"code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"File content type"}],"_postman_id":"06901c0d-142b-44b2-a6b0-063609196a3b"},{"name":"Get ICE servers","id":"46a50947-3e48-42cc-85b0-8271d448ff77","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":"https://This method returns a list of configured ICE servers to provide to the browser so that an audio-visual session could be added to the chat.
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":"https://This method returns the chat widget configuration for the launch point.
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"chat_session_message contains a new chat message.
\n{\n \"event\": \"chat_session_message\",\n \"msg_id\": \"<message id>\",\n \"msg\": \"<chat message>\",\n \"channel\": \"chat channel>\n}\nchat_session_typing is sent when the user of the client application starts typing.
\n{\n \"event\": \"chat_session_typing\"\n}\nchat_session_not_typing is sent when the user of the client application stops typing.
\n{\n \"event\": \"chat_session_not_typing\"\n}\nchat_session_form_data contains the data requested by the server via event chat_session_form_show.
\n{\n \"event\": \"chat_session_form_data\",\n \"form_request_id\": \"<form request ID from the corresponding server event>\",\n \"form_name\": \"<form name>\",\n \"data\": {\n \"param1\": \"value1\",\n …\n }\n}\nchat_session_secure_form_data contains the data requested by the server via event chat_session_secure_form_show.
\n{\n \"event\": \"chat_session_secure_form_data\",\n \"form_request_id\": \"<form request ID from the corresponding server event>\",\n \"form_name\": \"<form name>\",\n \"data\": {\n \"param1\": \"value1\",\n …\n }\n}\nchat_session_secure_form_cancel is to cancel the secure form.
\n{\n \"event\": \"chat_session_secure_form_cancel\",\n \"form_request_id\": \"<form request ID from the corresponding server event>\"\n}\nchat_session_end ends the chat session.
\n{\n \"event\": \"chat_session_end\"\n}\nchat_session_disconnect ends the current chat conversation but keeps the session open (i.e., controlled by the scenario). This message can be used instead of chat_session_end when additional information may be expected from the server (e.g., a survey form).
\n{\n \"event\": \"chat_session_disconnect\"\n}\nchat_session_signaling is a container message for WebRTC signaling messages from client to server. These messages are not stored in the chat session history.
\n{\n \"event\": \"chat_session_signaling\",\n \"msg_id\": \"<message id>\",\n \"destination_party_id\": \"<agent party id>\",\n \"data\": \"<signaling message>\"\n}\nchat_session_file provides notification that the client has uploaded a file to the server.
\n{\n \"event\": \"chat_session_file\",\n \"msg_id\": \"<message id>\",\n \"file_type\": \"<image|attachment>\",\n \"file_id\": \"<file id>\"\n}\nchat_session_location contains a new geographical location message.
\n{\n \"event\": \"chat_session_location\",\n \"msg_id\": \"<message id>\"\n \"url\": \"<map URL (optional)>\",\n \"latitude\": \"<latitude>\",\n \"longitude\": \"<longitude>\"\n}\nchat_session_navigation is sent from the client with its web page location (page name or url)
\n{\n \"event\": \"chat_session_navigation\",\n \"msg_id\": \"<message id>\",\n \"title\": \"<page title>\",\n \"page\": \"<page name or page url>\"\n}\nchat_session_cobrowsing_rejected is to notify the server that the user has rejected a co-browsing session.
\n{\n \"event\": \"chat_session_cobrowsing_rejected\"\n}\nchat_session_cobrowsing_started is to notify the server that the user has accepted and started a con-browsing session.
\n{\n \"event\": \"chat_session_cobrowsing_started\",\n \"provider_type\": \"<Name of chat co-browsing provider>\",\n \"cobrowsing_url\": \"<URL of the co-browsing session>\"\n}\nchat_session_cobrowsing_ended is to notify the server that the user has ended the co-browsing session.
\n{\n \"event\": \"chat_session_cobrowsing_ended\"\n}\nchat_session_status updates the current state of the chat session. If the state is failed, the client application shall assume that the chat session no longer exists.
\n{\n \"event\": \"chat_session_status\",\n \"state\": \"queued|connecting|connected|failed|completed\",\n \"ewt\": \"<estimated waiting time for queued status>\"\n}\nchat_session_ended indicates a normal termination of the chat session (e.g., when the chat session is closed by the agent). The client application shall assume that the chat session no longer exists.
\n{\n \"event\": \"chat_session_ended\"\n}\nchat_session_party_joined indicates that a new party (a new agent) has joined the chat session.
\n{\n \"event\": \"chat_session_party_joined\",\n \"party_id\": \"<party id>\",\n \"first_name\": \"<party first name>\",\n \"last_name\": \"<party last name>\",\n \"display_name\": \"<party display name>\",\n \"type\": \"<scenario|external|internal>\",\n \"timestamp\": \"<UTC timestamp in milliseconds>\"\n}\nchat_session_party_left indicates that one of the existing parties (an agent) has left the chat session.
\n{\n \"event\": \"chat_session_party_left\",\n \"party_id\": \"<party id>\",\n \"timestamp\": \"<UTC timestamp in milliseconds>\"\n}\nchat_session_message contains a new chat message.
\n{\n \"event\": \"chat_session_message\",\n \"party_id\": \"<party id>\",\n \"msg_id\": \"<message id>\",\n \"msg\": \"<chat message>\",\n \"timestamp\": \"<UTC timestamp in milliseconds>\"\n}\nchat_session_typing is sent when the agent starts typing.
\n{\n \"event\": \"chat_session_typing\",\n \"party_id\": \"<party id>\",\n \"timestamp\": \"<UTC timestamp in seconds>\"\n}\nchat_session_not_typing is sent when the agent stops typing.
\n{\n \"event\": \"chat_session_not_typing\",\n \"party_id\": \"<party id>\",\n \"timestamp\": \"<UTC timestamp in seconds>\"\n}\nchat_session_form_show is sent to the request user’s input from the client application to be entered via a predefined form. The client application is normally supposed to display the specified form to the user and send back the entered data via event chat_session_form_data.
\n{\n \"event\": \"chat_session_form_show\",\n \"form_request_id\": \"<request ID that will be used by the client application to associate the response>\",\n \"form_name\": \"<predefined form name known to the client application>\",\n \"form_timeout\": \"form timeout\",\n \"timestamp\": \"<UTC timestamp in seconds>\"\n}\nchat_session_secure_form_show is sent to notify the client application that it should display a secure, predefined form to the user and send back the entered data via event chat_session_secure_form_data.
\n{\n \"event\": \"chat_session_secure_form_show\",\n \"form_request_id\": \"<request ID that will be used by the client application in chat_session_secure_form_data>\",\n \"form_id\": \"<Form ID>\",\n \"timestamp\": \"<UTC timestamp in seconds>\"\n}\nchat_session_timeout_warning is sent to request that the specified text be displayed to the user of the client application. Typically, it is used to display an inactivity warning message.
\n{\n \"event\": \"chat_session_timeout_warning\",\n \"msg\": \"<warning text>\",\n \"timestamp\": \"<UTC timestamp in milliseconds>\"\n}\nchat_session_inactvity_timeout indicates the termination of the chat session due to the user’s inactivity and provides text to be displayed to the user. The client application shall assume that the chat session no longer exists.
\n{\n \"event\": \"chat_session_inactvity_timeout\",\n \"msg\": \"<inactivity timeout text>\",\n \"timestamp\": \"<UTC timestamp in milliseconds>\"\n}\nchat_session_signaling is a container message for WebRTC signaling messages from server to client. These messages are not stored in the chat session history.
\n{\n \"event\": \"chat_session_signaling\",\n \"msg_id\": \"<message id>\",\n \"data\": \"<signaling message>\"\n \n}\nchat_session_file provides notification that a file is being sent to the client. The client can use parameter file_id to download the file.
\n{\n \"event\": \"chat_session_file\",\n \"party_id\": \"<party id>\",\n \"msg_id\": \"<message id>\",\n \"file_id\": \"<file id>\",\n \"file_type\": \"<image|attachment>\",\n \"timestamp\": \"<event time in Unix format>\"\n}\nchat_session_location contains a new location message.
\n{\n \"event\": \"chat_session_location\",\n \"msg_id\": \"<message id>\"\n \"url\": \"<map url (optional)>”,\n \"latitude\": “<latitude>”,\n \"longitude\": “<longitude>”,\n \"timestamp\": \"<UTC timestamp in seconds>\"\n}\nchat_session_cobrowsing_requested is sent to the client application to request a co-browsing session.
\n{\n \"event\": \"chat_session_cobrowsing_requested\",\n \"msg_id\": \"<message id>\"\n}\nThis message is sent from the client to request a WebRTC call.
\n{\n \"type\": \"REQUEST_CALL”,\n \"offerVideo\": \"true|false\"\n}\nThis message is sent from the server to indicate that a requested call was rejected.
\n{\n \"type\": \"CALL_REJECTED\",\n \"reason_code\": \"<reject reason code>\",\n \"reason\": \"TBD\"\n}\nThis message is sent from the server to start a WebRTC session.
\n{\n \"type\": \"OFFER_CALL\",\n \"offerVideo\": \"true|false\",\n \"sdp\": \"<session description string\"\n}\nThis message is sent from the client to confirm the WebRTC session started by the server.
\n{\n \"type\": \"ANSWER_CALL\",\n \"sdp\": \"<session description string>\"\n}\nThis message is sent from the client or server with ICE candidate description.
\n{\n \"type\": \"ICE_CANDIDATE\",\n \"sdpMid\": \"<candidate id>\",\n \"sdpMLineIndex\": \"<candidate index>\",\n \"candidate\": \"<candidate description>\"\n}\nThis message is sent from the client or server to end the current WebRTC session.
\n{\n \"type\": \"END_CALL\"\n}\n