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
- 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.
- Add an extra language which is not included by default
- 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 key | value (en) |
---|---|
BACK_BUTTON_CAPTION | Back |
BLOCKED | At the moment it's not possible to set up a phone call. |
BLOCKED_BY_CUSTOMER | Your IP address is blocked by the company you are trying to reach, you are not able to make a call |
BLOCKED_BY_CUSTOMER_TITLE | Blocked by customer |
BLOCKED_GLOBALLY_TITLE | Blocked by PushCall |
BLOCKED_GLOBALY | Your IP address is blocked by PushCall, you are not able to make a call |
BLOCKED_GLOBALY_TITLE | Blocked |
BLOCKED_TITLE | Error |
BUSY | The line is busy, please try again later |
BUSY_TITLE | Busy |
CALL_BUTTON_CAPTION | <b>Call</b> |
CALL_ME_LATER_BUTTON_CAPTION | Call me on <br>{DD/MM/YY} at {HH:NN} |
CALL_ME_LATER_DESCRIPTION | You will be called at the specified time. |
CALL_ME_LATER_INPUT_VALUE | Your phone number |
CALL_ME_LATER_PUB_DATE_LABEL | {EEE DD/MM/YY} |
CALL_ME_LATER_SUCCESS_DESCRIPTION | We have received your request, we will call you on {DD/MM/YY} at {HH:NN}. |
CALL_ME_LATER_SUCCESS_TITLE | We will call you! |
CALL_ME_LATER_TITLE | When can we call you? |
CALL_ME_NOW_ADDRESS_BLOCKED_DESCRIPTION | The provided phone number is blocked, please provide another number |
CALL_ME_NOW_ADDRESS_BLOCKED_TITLE | Phone number is blocked |
CALL_ME_NOW_DESCRIPTION | Let us call you on your regular phone. Please enter your phone number. |
CALL_ME_NOW_INPUT_VALUE | Your phone number |
CALL_ME_NOW_NOTE | Monday till Friday, from 09.00 till 21.00. |
CALL_ME_NOW_SHORTCUT_CAPTION | Let us call you |
CALL_ME_NOW_SUCCESS_DESCRIPTION | We will call you ... |
CALL_ME_NOW_SUCCESS_TITLE | Success! |
CALL_ME_NOW_TITLE | Let us call you |
CLOSED | You 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_TITLE | Sorry, we are closed |
DATE_INPUT | Date: |
ERROR | An error occured, the following code might be helpfull to pindown the problem: |
ERROR_PHONENUMBER_INVALID | Please use a valid phone number |
ERROR_TITLE | An error has occured |
GO_TO_CML_BUTTON_CAPTION | Choose a Date/Time |
GO_TO_CML_MAIN | Go back to "Call me now" |
MONTH_ABBR_APR | Apr |
MONTH_ABBR_AUG | Aug |
MONTH_ABBR_DEC | Dec |
MONTH_ABBR_FEB | Feb |
MONTH_ABBR_JAN | Jan |
MONTH_ABBR_JUL | Jul |
MONTH_ABBR_JUN | Jun |
MONTH_ABBR_MAR | Mar |
MONTH_ABBR_MAY | May |
MONTH_ABBR_NOV | Nov |
MONTH_ABBR_OCT | Oct |
MONTH_ABBR_SEP | Sep |
NA | Service not available |
NA_TITLE | Not available |
OFFLINE_CALL_BUTTON_CAPTION | Call me |
OK_BUTTON_CAPTION | OK |
QUEUED | All our staff members are busy. We've placed your request in a queue. Your position in the queue: |
QUEUED_TITLE | Queue |
QUEUE_FULL | Due to high call volume, this service is temporarily unavailable. |
QUEUE_FULL_TITLE | Currently unavailable |
TEXT_CLOSED | closed |
TEXT_OPEN_ALL_DAY | all day |
TIME_HOUR | hour |
TIME_INPUT | Time: |
TIME_MINUTE | minute |
UNKNOWN_TARGET | An error occured, the following code might be helpfull to pindown the problem: 1416UT |
UNKNOWN_TARGET_TITLE | Unknown target |
WEEKDAY_ABBR_FRI | Fri. |
WEEKDAY_ABBR_MON | Mon. |
WEEKDAY_ABBR_SAT | Sat. |
WEEKDAY_ABBR_SUN | Sun. |
WEEKDAY_ABBR_THU | Thu. |
WEEKDAY_ABBR_TUE | Tue. |
WEEKDAY_ABBR_WED | Wed. |
REJECTED_TITLE 1 | Not available |
REJECTED 1 | We were unable to schedule a call for you at this time. Please select another time. |
1Available since v1.3.2
AppMeNow
label key | value |
---|---|
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 key | value |
---|---|
CHAT_REQUEST_TITLE | Start a chat |
BUTTON_LABEL_NAME | Name: |
BUTTON_LABEL_SUBJECT | Subject: |
BUTTON_LABEL_CONNECTING | Connecting… |
BUTTON_LABEL_EMAIL | |
BUTTON_CANCEL_CHAT | Cancel |
BUTTON_SUBMIT | Send |
TYPING_MESSAGE | {OPERATOR_NAME} is typing... |
JOIN_MESSAGE | Your chat is answered by {OPERATOR_NAME} |
LEAVE_MESSAGE | {OPERATOR_NAME} left the chat |
DISCONNECT_MESSAGE | The chat was disconnected |
LOADING_MESSAGE | Loading... |
UNKNOWN_TITLE | Unknown target |
UNKNOWN_MESSAGE | The specified target does not exist. |
CLOSED_TITLE | Chat not available |
CLOSED_MESSAGE | Unfortunately the chat service is currently unavailable. Please try again later. |
CANCELED_TITLE | Chat not available |
CANCELED_MESSAGE | You have cancelled the connection process. |
TIMEDOUT_TITLE | Chat not available |
TIMEDOUT_MESSAGE | Unfortunately we were not able to connect you to an available agent. Please try again later. |
CONNECTIONERROR_TITLE | Connection error |
CONNECTIONERROR_MESSAGE | A connection error occurred. Please try again later |
EMAIL_INVITE_MESSAGE | Please send us your question using our mail form and we will respond as soon as possible. |
ERROR_NAME_INVALID | This is a required field. |
ERROR_SUBJECT_INVALID | This is a required field. |
INPUT_MESSAGE_LABEL | Message |
INPUT_MESSAGE_PLACEHOLDER_LABEL | Type your message here... |
label key | value |
---|---|
EMAIL_TITLE | |
BUTTON_LABEL_NAME | Name: |
BUTTON_LABEL_PHONE | Phone number: |
BUTTON_LABEL_EMAIL | E-Mail address: |
BUTTON_LABEL_SUBJECT | Subject: |
BUTTON_LABEL_MESSAGE | Your message: |
CHECKBOX_LABEL_SEND_COPY | Send me a copy of the message. |
BUTTON_SEND_MESSAGE | Send |
ERROR | An 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 key | value |
---|---|
SCB_BUTTON_CAPTION_AUDIO | Give us a call |
SCB_BUTTON_CAPTION_CHAT | Have a chat with us |
SCB_BUTTON_CAPTION_CLOSED | Not available |
SCB_BUTTON_CAPTION_CML | Let us call you later |
SCB_BUTTON_CAPTION_CMN | Let us call you |
SCB_BUTTON_CAPTION_MAIL | Send us an E-mail |
SCB_BUTTON_CAPTION_NA | Not available |
Available languages
See the table below for the languages that are supported by default.
language | CmN/CmL | Chat | AppMeNow | Availability | |
---|---|---|---|---|---|
en | |||||
nl | |||||
de | |||||
fr | |||||
es | |||||
da | |||||
nb | |||||
pl | |||||
sv |
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/