Sparkcentral Messenger SDK

<script>
var initPromise = Sparkcentral.init({
integrationId: 'Integration ID here',
// Leave unspecified for US region (default)
region: 'eu-1',
 
//This makes sure the customer is not able to create multiple conversations.
canUserCreateMoreConversations: false,
canUserSeeConversationList: false,
 
customColors: {
brandColor: '65758e',
conversationColor: '65758e',
actionColor: '65758e',
},
menuItems: {
imageUpload: true,
fileUpload: true,
shareLocation: true
},
fixedHeader: false,
customText: {
actionPaymentCompleted: 'Payment Completed',
actionPaymentError: 'An error occurred while processing the card. <br> Please try again or use a different card.',
actionPostbackError: 'An error occurred while processing your action. Please try again.',
clickToRetry: 'Message not delivered. Click to retry.',
clickToRetryForm: 'Form not submitted. Click anywhere on the form to retry.',
connectNotificationText: 'Sync your conversation and continue messaging us through your favorite app.',
connectNotificationSingleText: 'Be notified when you get a reply.',
conversationListHeaderText: 'My conversations',
conversationListPreviewAnonymousText: 'Someone',
conversationListPreviewCarouselText: '{user} sent a message',
conversationListPreviewFileText: '{user} sent a file',
conversationListPreviewFormText: '{user} sent a form',
conversationListPreviewFormResponseText: '{user} filled a form',
conversationListPreviewImageText: '{user} sent an image',
conversationListPreviewLocationRequestText: '{user} sent a location request',
conversationListPreviewUserText: 'You',
conversationListRelativeTimeJustNow: 'Just now',
conversationListRelativeTimeMinute: '1 minute ago',
conversationListRelativeTimeMinutes: '{value} minutes ago',
conversationListRelativeTimeHour: '1 hour ago',
conversationListRelativeTimeHours: '{value} hours ago',
conversationListRelativeTimeYesterday: 'Yesterday',
conversationListTimestampFormat: 'MM/DD/YY',
conversationTimestampHeaderFormat: 'MMMM D YYYY, h:mm A',
couldNotConnect: 'Offline. You will not receive messages.',
couldNotConnectRetry: 'Reconnecting...',
couldNotConnectRetrySuccess: "You're back online!",
couldNotLoadConversations: 'Couldn’t load conversations.',
emailChangeAddress: 'Change my email',
emailDescription: 'To be notified by email when you get a reply, enter your email address.',
emailFieldLabel: 'Email',
emailFieldPlaceholder: 'Your email address',
emailFormButton: 'Submit',
emailLinkingErrorMessage: 'Please submit a valid email address.',
fetchHistory: 'Load more',
fetchingHistory: 'Retrieving history...',
fileTooLargeError: 'Max file size limit exceeded ({size})',
fileTypeError: 'Unsupported file type.',
formErrorInvalidEmail: 'Email is invalid',
formErrorNoLongerThan: 'Must contain no more than ({characters}) characters',
formErrorNoShorterThan: 'Must contain at least ({characters}) characters',
formErrorUnknown: 'This doesn\'t look quite right',
formFieldSelectPlaceholderFallback: 'Choose one...',
frontendEmailChannelDescription: 'To talk to us using email just send a message to our email address and we\'ll reply shortly:',
headerText: 'How can we help?',
imageClickToReload: 'Click to reload image.',
imageClickToView: 'Click to view {size} image.',
imagePreviewNotAvailable: 'Preview not available.',
inputPlaceholder: 'Type a message...',
inputPlaceholderBlocked: 'Complete the form above...',
introAppText: 'Message us below or from your favorite app.',
lineChannelDescription: 'To talk to us using LINE, scan this QR code using the LINE app and send us a message.',
linkChannelPageHeader: 'Sync your conversation',
linkError: 'An error occurred when attempting to generate a link for this channel. Please try again.',
locationNotSupported: 'Your browser does not support location services or it’s been disabled. Please type your location instead.',
locationSecurityRestriction: 'This website cannot access your location. Please type your location instead.',
locationSendingFailed: 'Could not send location',
locationServicesDenied: 'This website cannot access your location. Allow access in your settings or type your location instead.',
messageIndicatorTitlePlural: '({count}) New messages',
messageIndicatorTitleSingular: '({count}) New message',
messageRelativeTimeDay: '{value}d ago',
messageRelativeTimeHour: '{value}h ago',
messageRelativeTimeJustNow: 'Just now',
messageRelativeTimeMinute: '{value}m ago',
messageTimestampFormat: 'h:mm A',
messageDelivered: 'Delivered',
messageSeen: 'Seen',
messageSending: 'Sending...',
messengerChannelDescription: 'Connect your Facebook Messenger account to be notified when you get a reply and continue the conversation on Facebook Messenger.',
newConversationButtonText: 'New Conversation',
notificationSettingsChannelsDescription: 'Sync this conversation by connecting to your favorite messaging app to continue the conversation your way.',
notificationSettingsChannelsTitle: 'Other Channels',
notificationSettingsConnected: 'Connected',
notificationSettingsConnectedAs: 'Connected as {username}',
prechatCaptureGreetingText: 'Hi there \nTo start off, we\'d like to know a little bit more about you:',
prechatCaptureNameLabel: 'Your name',
prechatCaptureNamePlaceholder: 'Type your name...',
prechatCaptureEmailLabel: 'Email',
prechatCaptureEmailPlaceholder: 'name@company.com',
prechatCaptureConfirmationText: 'Thanks for that! What can we help you with?',
prechatCaptureMailgunLinkingConfirmation: 'You\'ll be notified here and by email at {email} once we reply.',
sendButtonText: 'Send',
settingsHeaderText: 'Settings',
shareLocation: 'Location',
smsBadRequestError: 'We were unable to communicate with this number. Try again or use a different one.',
smsCancel: 'Cancel',
smsChangeNumber: 'Change my number',
smsChannelDescription: 'Connect your SMS number to be notified when you get a reply and continue the conversation over SMS.',
smsChannelPendingDescription: 'Check your messages at {number} to confirm your phone number.',
smsContinue: 'Send',
smsInvalidNumberError: 'Please submit a valid phone number.',
smsLinkCancelled: 'Link to {appUserNumber} was cancelled.',
smsLinkPending: 'Pending',
smsPingChannelError: 'There was an error sending a message to your number.',
smsSendText: 'Send me a text',
smsStartTexting: 'Start Texting',
smsTooManyRequestsError: 'A connection for that number was requested recently. Please try again in {minutes} minutes.',
smsTooManyRequestsOneMinuteError: 'A connection for that number was requested recently. Please try again in 1 minute.',
smsUnhandledError: 'Something went wrong. Please try again.',
syncConversation: 'Sync conversation',
tapToRetry: 'Message not delivered. Tap to retry.',
tapToRetryForm: 'Form not submitted. Tap anywhere on the form to retry.',
telegramChannelDescription: 'Connect your Telegram account to be notified when you get a reply and continue the conversation on Telegram',
uploadDocument: 'File',
uploadInvalidError: 'Invalid file',
uploadPhoto: 'Image',
uploadVirusError: 'A virus was detected in your file and it has been rejected',
unsupportedMessageType: 'Unsupported message type.',
unsupportedActionType: 'Unsupported action type.',
viberChannelDescription: 'Connect your Viber account to be notified when you get a reply and continue the conversation on Viber. To get started, scan the QR code using the Viber app.',
viberChannelDescriptionMobile: 'Connect your Viber account to be notified when you get a reply and continue the conversation on Viber. To get started, install the Viber app and tap Connect.',
viberQRCodeError: 'An error occurred while fetching your Viber QR code. Please try again.',
wechatChannelDescription: 'Connect your WeChat account to be notified when you get a reply and continue the conversation on WeChat. To get started, scan this QR code using the WeChat app.',
wechatChannelDescriptionMobile: 'Connect your WeChat account to be notified when you get a reply and continue the conversation on WeChat. To get started, save this QR code image and upload it in the <a href=\'weixin://dl/scan\'>QR code scanner</a>.',
wechatQRCodeError: 'An error occurred while fetching your WeChat QR code. Please try again.',
whatsappChannelDescriptionDesktop: 'Sync your account to WhatsApp by scanning the QR code or clicking the link below.\nThen, send the pre-populated message to validate the sync request. (Your code: {{code}}).',
whatsappChannelDescriptionMobile: 'Sync your account to WhatsApp by clicking the link below.\nThen, send the pre-populated message to validate the sync request. (Your code: {{code}}).',
whatsappLinkingError: 'An error occurred while fetching your WhatsApp linking information. Please try again.'
}
}).then(function() {
// Your code after init is complete
});
</script>

Opens the conversation widget (NOOP when embedded)
Sparkcentral.open();
Closes the conversation widget (NOOP when embedded)
Sparkcentral.close();
Tells if the widget is currently opened or closed.
Sparkcentral.isOpened();
Logs a user in the Web Messenger, retrieving the conversations the user already had on other browser sessions and/or devices. Note that you don't need to call this after `init` if you already passed the external id and jwt as arguments in the call to `init`, in which case it's done internally as part of the initialization sequence. This returns a `Promise` that resolves when the Web Messenger is ready again.
Sparkcentral.login('externa-id', 'some-jwt');
Logs out the current user and reinitialize the widget with an anonymous user. This returns a promise that resolves when the Web Messenger is ready again.
Sparkcentral.logout();
Destroys the Web Messenger and makes it disappear. The Web Messenger has to be reinitialized with `init` to be working again because it also clears up the integration id from the Web Messenger. It will also unbind all listeners you might have with `Sparkcentral.on`.
Sparkcentral.destroy();
Sends a message to the targeted conversation on the user's behalf.
Sparkcentral.sendMessage(
{
type: 'text',
text: 'hello'
},
'<conversation-id>'
);
// OR
Sparkcentral.sendMessage('hello', '<conversation-id>');

Sparkcentral.init({
integrationId: '<integration-id>',
// Leave unspecified for US region (default)
region: 'eu-1',
// For authenticated mode
jwt: 'your_jwt',
userId: 'user_id',
locale: 'en-US',
customColors: {
brandColor: '65758e',
conversationColor: '65758e',
actionColor: '65758e',
},
 
menuItems: {
imageUpload: true,
fileUpload: true,
shareLocation: true
},
 
fixedIntroPane: false,
 
prechatCapture: {
enabled: true,
fields: [
{
type: 'email',
name: 'email',
label: 'Email',
placeholder: 'your@email.com'
},
{
type: 'text',
name: 'company-website',
label: 'Company website',
placeholder: 'mycompany.com'
},
{
type: 'select',
name: 'company-size',
label: 'Company size',
placeholder: 'Choose a number...',
options: [
{
name: '1-10',
label: '1-10 employees'
},
{
name: '11-50',
label: '11-50 employees'
},
{
name: '51+',
label: '51+ employees'
}
]
}
]
},
customText: {
actionPostbackError: 'An error occurred while processing your action. Please try again.',
clickToRetry: 'Message not delivered. Click to retry.',
connectNotificationText: 'Be notified inside your other apps when you get a reply.',
connectNotificationSingleText: 'Be notified when you get a reply.',
connectNotificationSingleButtonText: 'Turn on <name> notifications',
connectNotificationOthersText: 'others',
conversationTimestampHeaderFormat: 'MMMM D YYYY, h:mm A',
fetchHistory: 'Load more',
fetchingHistory: 'Retrieving history...',
fileTooLargeError: 'Max file size limit exceeded ({size})',
fileTypeError: 'Unsupported file type.',
headerText: 'How can we help?',
imageClickToReload: 'Click to reload image.',
imageClickToView: 'Click to view {size} image.',
imagePreviewNotAvailable: 'Preview not available.',
inputPlaceholder: 'Type a message...',
introductionText: 'We\'re here to talk, so ask us anything!',
invalidFileError: 'Only images are supported. Choose a file with a supported extension (jpg, jpeg, png, gif, or bmp).',
locationNotSupported: 'Your browser does not support location services or it’s been disabled. Please type your location instead.',
locationSecurityRestriction: 'This website cannot access your location. Please type your location instead.',
locationSendingFailed: 'Could not send location',
locationServicesDenied: 'This website cannot access your location. Allow access in your settings or type your location instead.',
messageError: 'An error occurred while sending your message. Please try again.',
messageIndicatorTitlePlural: '({count}) New messages',
messageIndicatorTitleSingular: '({count}) New message',
messageRelativeTimeDay: '{value}d ago',
messageRelativeTimeHour: '{value}h ago',
messageRelativeTimeJustNow: 'Just now',
messageRelativeTimeMinute: '{value}m ago',
messageTimestampFormat: 'h:mm A',
messageSending: 'Sending...',
messageDelivered: 'Delivered',
prechatCaptureGreetingText: 'Hi there \nTo start off, we\'d like to know a little bit more about you:',
prechatCaptureConfirmationText: 'Thanks for that! What can we help you with?',
sendButtonText: 'Send',
settingsHeaderText: 'Settings',
shareLocation: 'Share location',
tapToRetry: 'Message not delivered. Tap to retry.',
unsupportedMessageType: 'Unsupported message type.',
unsupportedActionType: 'Unsupported action type.',
uploadDocument: 'Upload document',
uploadInvalidError: 'Invalid file',
uploadPhoto: 'Upload photo',
}
}).then(function() {
// Your code after init is complete
});
initPromise.then(function() {
// do something
});
// pass it around...
initPromise.then(function() {
//do something else
});