The Bright Pattern Contact Center (BPCC) Mobile/Web Messaging API v2 is a RESTful API that allows developers to integrate chat and voice interactions with mobile devices or third-party applications. The BPCC Mobile/Web Messaging API v2 expands on our existing Mobile/Web Messaging API v1, and can be used for development of rich contact applications, such as customer-facing mobile, web, and messaging applications for advanced chat, voice, and video communications with Bright Pattern Contact Center-based contact centers.
\nIn addition to all the methods and events included in the v1 API, the Mobile/Web Messaging API v2 includes the following:
\nSupport for the Apple Push Notification service (iOS) and Firebase Cloud Messaging push notifications (Android and iOS) with the Mobile Notification Subscription method
\nThe Get Case History method, which returns the combined transcripts of all chat sessions linked to a specific CRM Case object
\nThe Close Case method, which allows a client application request to close the case associated with the chat session
\nThe Get Version method, which returns the version of Bright Pattern Contact Center used on the server.
\nServer and client events indicating that a chat session message was delivered or read
\nA server event indicating if a chat session case was set
\nThe BPCC Mobile/Web Messaging API v2 endpoint prefix is as follows:
\nhttps://[tenant_url]/clientweb/api/v2/
\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":"6735878","collectionId":"99782afa-b5be-402f-bc11-d45f6cd68339","publishedId":"TzXwFJFP","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-05-25T23:12:43.000Z"},"item":[{"name":"General Information","item":[],"id":"4485aab9-cb91-4597-a705-8474cc90a18f","description":"The following is an example of an API request:
\nURL: https://yourcompany.brightpattern.com/clientweb/api/v2/chats?tenantUrl=yourcompany.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: 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":"d1cc90b6-0ba9-4be7-90d0-f24a8d7dd67b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"35750d2b-5d25-4070-885f-1410bca28a72","type":"text/javascript","exec":[""]}}],"_postman_id":"4485aab9-cb91-4597-a705-8474cc90a18f"},{"name":"Methods","item":[{"name":"Check Availability","id":"c8ba5507-80e9-4407-b2eb-92ddcb8032d6","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":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 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 is a client application request for either subscribing to or canceling mobile notifications for a chat session.
\nThis method should be invoked after invoking the Request Chat method (i.e., the chatId value required for this method is returned in the Request Chat method).
\nAdditionally, this method should be invoked when its device token is changed.
\nThe client application may also opt to stop receiving mobile notifications by using this API method\nwith an empty JSON body: {}
\nThe mobile application will specify one of the following parameters, depending on the application’s\noperating system and used notification framework.
\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":"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":"{\n \"events\":[\n \"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":"60699c15-539c-4784-8f66-d7f212caf222","name":"Send Events Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\""},{"key":"User-Agent","type":"text","value":"MobileClient"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n “events”: [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":"a1565388-2d45-4460-8e11-a2075f0656f5","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/v2/chats/:chatId/history?tenantUrl=yourcompany.brightpattern.com","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v2","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":"83305bb7-90b5-47b8-8f64-6152c998ef1d","name":"Get New Chat Events Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\""},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":{"raw":"https://yourcompany.brightpattern.com/clientweb/api/v2/chats/:chatId/events?tenantUrl=yourcompany.brightpattern.com","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v2","chats",":chatId","events"],"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","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":"ea723ed5-4523-4d73-a4e8-25c5019fe527","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/v2/chats/:chatId/files/:fileId","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v2","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":"5c771d1f-1d12-4b77-9597-dffc1e3937eb"},{"name":"Get Agent Profile Photo","id":"dedd0d48-096a-4934-937b-ef6224551997","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 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 party ID of the agent for the current chat session
\n","type":"text/plain"},"type":"any","value":"","key":"partyId"}]}},"response":[{"id":"31c992c1-9c68-4389-91eb-0170ca2be3d3","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/v2/chats/:chatId/profilephotos/:partyId","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v2","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":"dedd0d48-096a-4934-937b-ef6224551997"},{"name":"Get ICE servers","id":"e1aa5b22-9f9a-4571-9e7c-e8c759826aee","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":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 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","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"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":"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 combined transcripts of all chat sessions (i.e., the chat thread) linked to the specific CRM case object. Note that this request should be made only after the chat_session_case_set server event is received; if the scenario has not specified a case, the request will return an error.
\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 invokes a client application request to close the case associated with the chat session. Note that this request should be made only after the chat_session_case_set server event is received; if the scenario has not specified a case, the request will return an error.
\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 Bright Pattern Contact Center software version of the server. It may be used for informational purposes (e.g., adding the version number to the bottom of an application window or in an informational dialog window, as well as seeing the server version in the client application logs). Note that this method is not available in the Mobile/Web Messaging API v1.
\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":"This event 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}\nThe mobile application sends this event when it receives the message from another party.
\n{\n \"event\": \"chat_session_message_delivered\",\n \"ref_msg_id\": \"<message id>\"\n}\nThe mobile application sends this event when the user reads the message.
\n{\n \"event\": \"chat_session_message_read\",\n \"ref_msg_id\": \"<message id>\"\n}\nThis event is sent when the user of the client application starts typing.
\n{\n \"event\": \"chat_session_typing\"\n}\nThis event is sent when the user of the client application stops typing.
\n{\n \"event\": \"chat_session_not_typing\"\n}\nThis event contains the data requested by the server via the 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}\nThis event contains the data requested by the server via the 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}\nThis event is sent from or to the server to notify that the secure form was canceled.
\n{\n \"event\": \"chat_session_secure_form_cancel\",\n \"form_request_id\": \"<form request ID from the corresponding server event>\"\n}\nThis event ends the chat session.
\n{\n \"event\": \"chat_session_end\"\n}\nThis event 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}\nThis event 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}\nThis event 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}\nThis event 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}\nThis event is sent from the client with its web page location (i.e., the page name or the URL).
\n{\n \"event\": \"chat_session_navigation\",\n \"msg_id\": \"<message id>\",\n \"title\": \"<page title>\",\n \"page\": \"<page name or page url>\"\n}\nThis event notifies the server that the user has rejected a co-browsing session.
\n{\n \"event\": \"chat_session_cobrowsing_rejected\"\n}\nThis event notifies the server that the user has accepted and started a co-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}\nThis event notifies the server that the user has ended the co-browsing session.
\n{\n \"event\": \"chat_session_cobrowsing_ended\"\n}\nThis event updates the current state of the chat session. If the state is failed, the client application will 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}\nThis event indicates a normal termination of the chat session (e.g., when the chat session is closed by the agent). The client application will assume that the chat session no longer exists.
\n{\n \"event\": \"chat_session_ended\"\n}\nThis event indicates that a new party (i.e., 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}\nThis event indicates that one of the existing parties (e.g., 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}\nThis event 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}\nThe mobile application will receive this event when an agent or another party in the chat receives the message sent by the client application.
\n{\n \"event\": \"chat_session_message_delivered\",\n \"party_id\": \"<party id>\",\n \"ref_msg_id\": \"<message id>\",\n \"timestamp\": \"<UTC timestamp in seconds>\"\n}\nThe mobile application will receive this event when an agent or another party in the chat reads the message sent by the client application.
\n{\n \"event\": \"chat_session_message_read\",\n \"party_id\": \"<party id>\",\n \"ref_msg_id\": \"<message id>\",\n \"timestamp\": \"<UTC timestamp in seconds>\"\n}\nThis event 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}\nThis event 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}\nThis event 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 the 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}\nThis event 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 the 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}\nThis event 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}\nThis event 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 will 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}\nThis event is a container message for WebRTC signaling messages from the server to the 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}\nThis event provides notification that a file is being sent to the client. The client can use the 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}\nThis event 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}\nThis event 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}\nThe mobile application will receive this event when the scenario specifies the CRM Case ID for the chat session. Once a case is set, the mobile application may use the Get Case History method and the Close Case method.
\n{\n \"event\": \"chat_session_case_set\",\n \"case_id\": \"<message id>\",\n \"timestamp\": \"<UTC timestamp in seconds>\"\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