jQuery client plugin userMessages documentation

Since v1.2.0 of the plugin it's possible to use custom texts for the text labels in the HTML versions of the clients for:

  • CallMeNow
  • CallMeLater
  • Mail
  • Chat

This feature is also available for customizing the texts in the availability plugin.

This document describes the several possibilities.

Use cases

There are generally two use cases for using this feature.

  1. Add an extra language which is not included by default
  2. Override some (or all) of the labels for an existing translation

Both uses cases are supported. See the example section below.

Available labels

CallMeNow / CallMeLater

label keyvalue (en)
BACK_BUTTON_CAPTIONBack
BLOCKEDAt the moment it's not possible to set up a phone call.
BLOCKED_BY_CUSTOMERYour IP address is blocked by the company you are trying to reach,  you are not able to make a call
BLOCKED_BY_CUSTOMER_TITLEBlocked by customer
BLOCKED_GLOBALLY_TITLEBlocked by PushCall
BLOCKED_GLOBALYYour IP address is blocked by PushCall,  you are not able to make a call
BLOCKED_GLOBALY_TITLEBlocked
BLOCKED_TITLEError
BUSYThe line is busy,  please try again later
BUSY_TITLEBusy
CALL_BUTTON_CAPTION<b>Call</b>
CALL_ME_LATER_BUTTON_CAPTIONCall me on <br>{DD/MM/YY} at {HH:NN}
CALL_ME_LATER_DESCRIPTIONYou will be called at the specified time.
CALL_ME_LATER_INPUT_VALUEYour phone number
CALL_ME_LATER_PUB_DATE_LABEL{EEE DD/MM/YY}
CALL_ME_LATER_SUCCESS_DESCRIPTIONWe have received your request, we will call you on {DD/MM/YY} at {HH:NN}.
CALL_ME_LATER_SUCCESS_TITLEWe will call you!
CALL_ME_LATER_TITLEWhen can we call you?
CALL_ME_NOW_ADDRESS_BLOCKED_DESCRIPTIONThe provided phone number is blocked,  please provide another number
CALL_ME_NOW_ADDRESS_BLOCKED_TITLEPhone number is blocked
CALL_ME_NOW_DESCRIPTIONLet us call you on your regular phone. Please enter your phone number.
CALL_ME_NOW_INPUT_VALUEYour phone number
CALL_ME_NOW_NOTEMonday till Friday,  from 09.00 till 21.00.
CALL_ME_NOW_SHORTCUT_CAPTIONLet us call you
CALL_ME_NOW_SUCCESS_DESCRIPTIONWe will call you ...
CALL_ME_NOW_SUCCESS_TITLESuccess!
CALL_ME_NOW_TITLELet us call you
CLOSEDYou can reach us during the following hours:<br/><br/>monday : {{monday_times}}<br/>tuesday : {{tuesday_times}}<br/>wednesday: {{wednesday_times}}<br/>thursday : {{thursday_times}}<br/>friday : {{friday_times}}<br/>saturday : {{saturday_times}}<br/>sunday : {{sunday_times}}
CLOSED_TITLESorry, we are closed
DATE_INPUTDate:
ERRORAn error occured, the following code might be helpfull to pindown the problem:
ERROR_PHONENUMBER_INVALIDPlease use a valid phone number
ERROR_TITLEAn error has occured
GO_TO_CML_BUTTON_CAPTIONChoose a Date/Time
GO_TO_CML_MAINGo back to "Call me now"
MONTH_ABBR_APRApr
MONTH_ABBR_AUGAug
MONTH_ABBR_DECDec
MONTH_ABBR_FEBFeb
MONTH_ABBR_JANJan
MONTH_ABBR_JULJul
MONTH_ABBR_JUNJun
MONTH_ABBR_MARMar
MONTH_ABBR_MAYMay
MONTH_ABBR_NOVNov
MONTH_ABBR_OCTOct
MONTH_ABBR_SEPSep
NAService not available
NA_TITLENot available
OFFLINE_CALL_BUTTON_CAPTIONCall me
OK_BUTTON_CAPTIONOK
QUEUEDAll our staff members are busy. We've placed your request in a queue. Your position in the queue:
QUEUED_TITLEQueue
QUEUE_FULLDue to high call volume,  this service is temporarily unavailable.
QUEUE_FULL_TITLECurrently unavailable
TEXT_CLOSEDclosed
TEXT_OPEN_ALL_DAYall day
TIME_HOURhour
TIME_INPUTTime:
TIME_MINUTEminute
UNKNOWN_TARGETAn error occured,  the following code might be helpfull to pindown the problem: 1416UT
UNKNOWN_TARGET_TITLEUnknown target
WEEKDAY_ABBR_FRIFri.
WEEKDAY_ABBR_MONMon.
WEEKDAY_ABBR_SATSat.
WEEKDAY_ABBR_SUNSun.
WEEKDAY_ABBR_THUThu.
WEEKDAY_ABBR_TUETue.
WEEKDAY_ABBR_WEDWed.
REJECTED_TITLE 1Not available
REJECTED 1We were unable to schedule a call for you at this time. Please select another time.

1Available since v1.3.2

AppMeNow

label keyvalue
AMN_TITLE Contact via WhatsApp
AMN_DESCRIPTION Provide your mobile phone number and we will send you instructions on how to contact us via WhatsApp.
AMN_BUTTON_APP_ME_NOW Let's App!
AMN_PHONE_INPUT_LABEL Mobile phone number
AMN_TITLE_INVITE_SENT Success
AMN_DESCRIPTION_INVITE_SENT You will receive instructions on how to contact us in a moment.
AMN_TITLE_ERROR_SENDING_INVITE We're sorry
AMN_DESCRIPTION_ERROR_SENDING_INVITE We were unable to send you the instructions.
AMN_ERROR_TRY_AGAIN contacting us directly
AMN_PHONENUMBER_FIELDSET_LEGEND Phone number
AMN_ERROR_PHONENUMBER_INVALID Please use a valid mobile phone number
AMN_FORM_CONTACT_INFO send us a WhatsApp message
AMN_CONTACT_INFO_SHOW_QR_CODE show QR Code
AMN_BACK Back
AMN_TITLE_SCAN_WITH_A_QR_READER Scan with a QR Reader
AMN_DESCRIPTION_CONTACT_INFO Add the following phone number to your phones address book and send us your question or remark via WhatsApp
AMN_TITLE_ERROR_NOT_AVAILABLE Not available
AMN_DESCRIPTION_ERROR_NOT_AVAILABLE The WhatsApp service is not available
AMN_TITLE_GENERAL_ERROR Something went wrong

Chat

label keyvalue
CHAT_REQUEST_TITLEStart a chat
BUTTON_LABEL_NAMEName:
BUTTON_LABEL_SUBJECTSubject:
BUTTON_LABEL_CONNECTINGConnecting…
BUTTON_LABEL_EMAILE-Mail
BUTTON_CANCEL_CHATCancel
BUTTON_SUBMITSend
TYPING_MESSAGE{OPERATOR_NAME} is typing...
JOIN_MESSAGEYour chat is answered by {OPERATOR_NAME}
LEAVE_MESSAGE{OPERATOR_NAME} left the chat
DISCONNECT_MESSAGEThe chat was disconnected
LOADING_MESSAGELoading...
UNKNOWN_TITLEUnknown target
UNKNOWN_MESSAGEThe specified target does not exist.
CLOSED_TITLEChat not available
CLOSED_MESSAGEUnfortunately the chat service is currently unavailable. Please try again later.
CANCELED_TITLEChat not available
CANCELED_MESSAGEYou have cancelled the connection process.
TIMEDOUT_TITLEChat not available
TIMEDOUT_MESSAGEUnfortunately we were not able to connect you to an available agent. Please try again later.
CONNECTIONERROR_TITLEConnection error
CONNECTIONERROR_MESSAGEA connection error occurred. Please try again later
EMAIL_INVITE_MESSAGEPlease send us your question using our mail form and we will respond as soon as possible.
ERROR_NAME_INVALIDThis is a required field.
ERROR_SUBJECT_INVALIDThis is a required field.
INPUT_MESSAGE_LABELMessage
INPUT_MESSAGE_PLACEHOLDER_LABELType your message here...

E-mail

label keyvalue
EMAIL_TITLE E-mail
BUTTON_LABEL_NAMEName:
BUTTON_LABEL_PHONEPhone number:
BUTTON_LABEL_EMAILE-Mail address:
BUTTON_LABEL_SUBJECTSubject:
BUTTON_LABEL_MESSAGEYour message:
CHECKBOX_LABEL_SEND_COPY Send me a copy of the message.
BUTTON_SEND_MESSAGESend
ERRORAn error occured,  the following code might be helpfull to pindown the problem,  the following code might be helpfull to pindown the problem:
ERROR_TITLE An error has occured
TARGET_INVALID The target '{target}' is not available.
TARGET_NOSERVICE There is no address available for target '{target}'.
SENDING Your e-mail is being sent.
SEND_OK Your e-mail has been sent.
VALIDATE_EMPTY This is a required field.
VALIDATE_EMAIL Invalid email address.
VALIDATE_MIN This field should have at least '{length}' characters.
VALIDATE_MAX This field can have a maximum of '{length}' characters.

Availability

label keyvalue
SCB_BUTTON_CAPTION_AUDIOGive us a call
SCB_BUTTON_CAPTION_CHATHave a chat with us
SCB_BUTTON_CAPTION_CLOSEDNot available
SCB_BUTTON_CAPTION_CMLLet us call you later
SCB_BUTTON_CAPTION_CMNLet us call you
SCB_BUTTON_CAPTION_MAILSend us an E-mail
SCB_BUTTON_CAPTION_NANot available

 

Available languages

See the table below for the languages that are supported by default.

languageCmN/CmLMailChatAppMeNowAvailability
en(tick)(tick)(tick)(tick)(tick)
nl(tick)(tick)(tick)(tick)(tick)
de(tick)(tick)(tick) (tick)
fr(tick)   (tick)
es(tick)   (tick)
da(tick)   (tick)
nb(tick)   (tick)
pl(tick)   (tick)
sv(tick)   (tick)

 

Examples

Add an extra language which is not included by default

    $('#dmail').pcclient({
        targetName: '<your_targetname_here>',
        clientType: 'mail',
        locale: 'li', //Lorem Ipsum
        userMessages: {
            li:{
				EMAIL_TITLE: 'Lorem',
				BUTTON_LABEL_NAME:'Ipsum:',
				BUTTON_LABEL_PHONE:'Sit amet:',
				BUTTON_LABEL_EMAIL:'Consectetur:',
				BUTTON_LABEL_SUBJECT:'Nam:',
				BUTTON_LABEL_MESSAGE:'Adipiscing elit:',
				CHECKBOX_LABEL_SEND_COPY: 'Iaculis vitae interdum a.',
				BUTTON_SEND_MESSAGE:'Nam',
				ERROR: 'Nulla nulla, proin efficitur imperdiet tincidunt.:',
				ERROR_TITLE: 'Phasellus et ligula ex',
				TARGET_INVALID: 'Fusce \'{target}\' ullamcorper felis arcu.',
				TARGET_NOSERVICE: 'Eget dapibus leo luctus at \'{target}\'.',
				SENDING: 'Etiam finibus elit nec pellentesque aliquam.',
				SEND_OK: 'Etiam finibus elit nec pellentesque aliquam.',
				VALIDATE_EMPTY: 'Proin consequat mauris ac metus volutpat molestie.',
				VALIDATE_EMAIL: 'Aliquam vel consectetur ante.',
				VALIDATE_MIN: 'Interdum et malesuada fames ac ante \'{length}\' ipsum.',
				VALIDATE_MAX: 'Suspendisse id posuere sem \'{length}\' faucibus.'
            }
        },
        forceHTML: true,
    });	

See this in action here: http://jsfiddle.net/pushcall/8sj44crd/embedded/result,js,html

Override some of the labels for an existing translation

    $('#dcmn').pcclient({
        targetName: '<your_targetname_here>',
        clientType: 'cmn',
        locale: 'en',
        userMessages: {
            en:{
                'CALL_ME_NOW_TITLE': 'This is a custom title'
            }
        },
        forceHTML: true,
    });

See this in action here: http://jsfiddle.net/pushcall/0o5dntj8/embedded/result,js/