Customize Strings for iOS
The UI SDK provides default text for all the messages that a user can encounter. You can customize the strings in your app using resource files.
This article applies to the following implementations:
To customize these strings in your app, create an Localizable.strings localizable resource file in your app and override the string keywords. For example:
To learn more, see the Apple documentation on String Resources. To learn about which languages the SDK supports, see Language Support.
| Keyword | Default Value | Description |
|---|
| SMI.Feed.Action.Menu.Accessibility | Action Menu | The accessibility string for the Action Menu to the left of the text input. |
| SMI.Feed.Action.Menu.File.Send | Send a File | Action Menu text for sending a file. |
| SMI.Feed.Action.Menu.Photo.Send | Send a Photo | Action Menu text for sending a photo. |
| SMI.Feed.Action.Menu.Photo.Take | Take a Photo | Action Menu text for taking a photo. |
| SMI.Feed.Action.Menu.Title | Send an attachment | The title of the action menu. |
| Keyword | Default Value | Description |
|---|
| SMI.Transfer.Requested.Event.Text | Transfer requested at %s | A system message informing the user that an agent transfer has been requested. |
| Keyword | Default Value | Description |
|---|
| SMI.Alert.Action.Retry | Retry | Retry action for the retry message alert. |
| SMI.Alert.Attachment.Limit.Reached | Attachment limit reached | Confirmation text for the retry message alert. |
| SMI.Alert.Message.Failed | Message failed to send. Retry? | Confirmation text for the retry message alert. |
| SMI.Alert.Message.Permission.Camera | To use your camera, go to Settings and enable Camera access for this app | Explanation for how to allow camera permission. |
| SMI.Alert.Title.Failed | Message Failed | Alert title text for the retry message alert. |
| SMI.Alert.Title.Permission.Camera | Allow Camera Access | Alert title text for requesting camera access. |
| Keyword | Default Value | Description |
|---|
| SMI.Attachment.Download.Failed.Message | Failed to save attachment | Shown in popup when the user clicks the download button and the attachment fails to save. |
| SMI.Camera.Capture.Button.Accessibility | Capture photo. | Accessibility text for the button to capture a photo. |
| SMI.Camera.Gallery.Button.Accessibility | Photo gallery. | Accessibility text for the button to open the photo gallery. |
| SMI.Camera.Switch.Lens.Button.Accessibility | Switch lens direction. | Accessibility text for the button to switch the camera lens direction. |
| SMI.Camera.View.Capturing.Accessibility | Camera capturing photo | Accessibility text for the view that displays the phone camera capturing a photo. |
| SMI.File.Format.Unsupported | Unsupported file format. | Message shown if the user sends an unsupported file. |
| SMI.File.Size.Exceeded | Attachment is too large. Maximum size is %s | Message shown if the user sends an attachment that exceeds the maximum size that can be sent. chat. |
| SMI.Image.Accessibility | Image message. | Accessibility text for an image message in the chat feed or attachment preview. |
| SMI.Image.Download.Denied.Body | To save photos, go to Settings and enable Photos access for this app. | Message shown in popup when the user tries to save a photo with denied permission. |
| SMI.Image.Download.Denied.Title | Allow Photo Access | Title shown in popup when the user tries to save a photo with denied permission. |
| SMI.Image.Preview.Accessibility | Image preview. | Accessibility text for the image preview dialog. |
| SMI.Image.Preview.Cancel.Button.Accessibility | Close image preview. | Accessibility text for the button to close the image preview dialog. |
| SMI.Image.Saved.Message | Image saved | Shown in popup when the user clicks the download button and the attachment successfully saves. |
| SMI.Image.Viewer.Download.Photo.Accessibility | Download photo | Accessibility text for the download button in the image viewer. |
| SMI.Image.Viewer.Jump.To.Photo.Accessibility | Jump to photo | Accessibility text for the jump to photo button in the image viewer. |
| SMI.Image.Viewer.Share.Photo.Accessibility | Share photo | Accessibility text for the share button in the image viewer. |
| SMI.Header.Share.Gif.Viewer | GIF | Shown when the user taps the share button when viewing a GIF in the attachment viewer. |
| SMI.Header.Share.Image.Viewer | Image | Shown when the user taps the share button when viewing an image in the attachment viewer. |
| SMI.Header.Share.Pdf.Viewer | PDF | Shown when the user taps the share button when viewing a PDF in the attachment viewer. |
| SMI.Multiple.Attachment.Counter | +%d | A counter that takes an integer representing the number of file attachments not shown. |
| SMI.Remove.Image.Button.Accessibility | Remove image message. | Accessibility text for the button to remove an image message from the input field. |
| Keyword | Default Value | Description |
|---|
| SMI.Business.Hours.Outside | New chats aren't available outside of business hours | The message that is shown in the chat feed banner when outside of business hours. |
| SMI.Business.Hours.Outside.Accessibility | New chats aren't currently available. Try again during business hours. | The accessibility announcement that informs the user that they are out of the set business hours and the contact center is closed. |
| Keyword | Default Value | Description |
|---|
| SMI.Carousel.Image.Accessibility | Carousel image | The default image description for a carousel option if no description is given. |
| SMI.Carousel.Image.Placeholder.Accessibility | Empty carousel image | A placeholder icon to indicate there is no image for a carousel option. |
| SMI.Carousel.Selected.Icon.Accessibility | Option selected | An icon to indicate that an option has been selected for a carousel message. |
| Keyword | Default Value | Description |
|---|
| SMI.Chat.Add.Button | Open option menu | Content description for the add button in the chat view to open the options menu. |
| SMI.Chat.Feed.Accessibility | Chat Feed | Accessibility label for the chat feed container view. |
| SMI.Chat.Feed.Title | Chat | Title for the chat feed view. |
| SMI.Chat.Start.Conversation | Start Conversation | Content description for a button that is used to resubmit pre-chat fields mid-conversation. |
| SMI.Chat.Start.Conversation.Feed.Input.Text.Accessibility | Fill out a pre-chat form to continue the conversation | Accessibility announcement when the user needs to enter and resubmit pre-chat fields. |
| Keyword | Default Value | Description |
|---|
| SMI.Feed.Input.Button | Send | Action text for the send message button. |
| SMI.Feed.Input.Text | Type a message | Placeholder text inside chat input field. |
| SMI.Feed.Input.Text.Accessibility | Message Input | Accessibility label for identifying the input control. |
| SMI.Feed.New.Messages | New Messages | A notification that alerts the user that there are new unread messages in the chat feed. |
| SMI.Feed.New.Messages.Accessibility | You have new messages. | An accessibility announcement that alerts the user that there are new unread messages in the chat feed. |
| SMI.Feed.New.Messages.Button.Accessibility | Scroll to bottom of chat feed. | The description for the notification badge button that alerts a user that they'll be brought to the bottom of the feed. |
| Keyword | Default Value | Description |
|---|
| SMI.Action.Copy | Copy | Text displayed in the context menu for the copy behavior. |
| SMI.Action.Copy.Attachment | Copy Attachment | Text displayed in the context menu for copying an attachment (when selecting part of a conversation entry that includes text and an attachment). |
| SMI.Copy.Text | Copy Text | Text displayed in the context menu for copying text (when selecting part of a conversation entry that includes text and an attachment). |
| Keyword | Default Value | Description |
|---|
| SMI.Delivery.Status.Delivered | Delivered | The message auxiliary view that displays the delivered message indicator. |
| SMI.Delivery.Status.Error | Send failed. Tap to retry. | The message auxiliary view that displays a send failure. |
| SMI.Delivery.Status.Error.Accessibility | Failed | The concise failed status for accessibility. |
| SMI.Delivery.Status.Error.Additional.Information.Required | Provide additional info to proceed. | The error message that appears when receiving a 417 error. This message corresponds to needing to resubmit pre-chat fields. |
| SMI.Delivery.Status.Error.Hint.Accessibility | Double tap to retry | Hint for the user to double tap the message to retry. |
| SMI.Delivery.Status.Error.UnsupportedMediaType | Chatbots can't receive attachments. | The error message appears when trying to send attachments that aren’t supported. |
| SMI.Delivery.Status.Read | Read | The message auxiliary view that displays the read message indicator. |
| SMI.Delivery.Status.Sending | Sending | The message auxiliary view that displays the sending message indicator. |
| SMI.Delivery.Status.Sent | Sent | The message auxiliary view that displays the sent message indicator. |
| SMI.Delivery.Timestamp.Today | Today • %s | The message auxiliary view that displays the time information for the day today with the timestamp. |
| SMI.Delivery.Timestamp.Yesterday | Yesterday • %s | The message auxiliary view that displays the time information for the day yesterday with the timestamp. |
| SMI.Local.Message.Identifier.Accessibility | Your Message | The accessibility text for identifying messages sent from the local user. |
| SMI.Message.Received.Event.Accessibility | Message received from %s | The accessibility announcement text that informs the user when a message has been received. |
| SMI.Message.Sending.Event.Accessibility | Message sent | The accessibility announcement text that informs the user that their message is sending. |
| Keyword | Default Value | Description |
|---|
| SMI.Link.Preview.Accessibility | Link preview | The screen reader reads out link preview and then the name of the link. |
| Keyword | Default Value | Description |
|---|
| SMI.Loading.Screen.Accessibility | Active loading screen | A message that is read to the user when a loading screen is shown or when the loading screen is selected. |
| Keyword | Default Value | Description |
|---|
| SMI.Message.Search.Agent.Avatar.Accessibility | Agent avatar | Accessibility text for the agent avatar in message search search. |
| SMI.Message.Search.Agent.Bot.Accessibility | Bot avatar | Accessibility text for the bot avatar in message search search. |
| SMI.Message.Search.Back.Button | Back | The back button for message search. |
| SMI.Message.Search.Clear.Search.Text.Accessibility | Clear search text | Accessibility text for clearing the search field in message search. |
| SMI.Message.Search.Header | Message Search | Header for the message search page. |
| SMI.Message.Search.User.Avatar.Accessibility | User avatar | Accessibility text for the user avatar in message search search. |
| SMI.No.Matching.Results | We couldn’t find what you’re looking for. Try searching for something else. | Message displayed when nothing matches the user's search. |
| SMI.No.Recent.Searches | You haven't performed a recent search. Enter keywords in the search field. | Message displayed when there are no search results and no text is entered in the search field. |
| SMI.No.Search.Results | No search results | Message displayed when there are no search results. |
| SMI.Nothing.Entered.In.Search | Nothing here yet | Message displayed when there’s nothing in the search bar and there are no recent searches. |
| SMI.Recent.Searches.Header | Recent Searches | Header for the recent search list. |
| SMI.Search.Placeholder.Text | Search | Placeholder text for the search bar. |
| SMI.Today.Timestamp.Message.Search | Today | Timestamp text for when the message was sent today. |
| SMI.Users.Name | You | The name shown for the user in the timestamp row. |
| SMI.Yesterday.Timestamp.Message.Search | Yesterday | Timestamp text for when the message was sent yesterday. |
| Keyword | Default Value | Description |
|---|
| SMI.Action.Cancel | Cancel | Cancel action to be used for cancel button and menus throughout the SDK. |
| SMI.Action.Settings | Settings | Settings action for permission alerts. |
| SMI.File.Size.Megabyte | MB | Size of a file in megabytes. |
| SMI.Misc.Separator | • | Separator used when conjoining information together in a string. |
| SMI.Misc.Unknown | Unknown | This string is used when a value or result cannot be determined. |
| SMI.Unknown.Entry.Message | Agent sent an unsupported message type. | The message shown when displaying an unknown entry in the chat feed. |
| Keyword | Default Value | Description |
|---|
| SMI.Network.Status.Connected | Connected | The network connectivity banner that will inform the user the network has connected after the network has lost connectivity. |
| SMI.Network.Status.Connected.Accessibility | Network connectivity established | The accessibility announcement that informs the user when the network is connected after having lost connectivity. |
| SMI.Network.Status.Reconnecting | Waiting to reconnect | The network connectivity banner text that informs the user the network connection has been lost and is attempting to reconnect. |
| SMI.Network.Status.Reconnecting.Accessibility | Network connectivity is lost, attempting to reconnect | The accessibility announcement that informs the user when the network connection has been lost and is attempting to reconnect |
| Keyword | Default Value | Description |
|---|
| SMI.Participant.Client.Menu.Title | Conversation Options | Text displayed in the header of the participant client menu. The participant client menu will contain actions a user can take in a chat feed. |
| SMI.Participant.Client.Menu.Title.Accessibility | Conversation Options Menus | The accessibility message for the participant client menu. |
| Keyword | Default Value | Description |
|---|
| SMI.Participant.Changed.Joined | %s has joined | The accessibility announcement that informs the user that a participant has joined the conversation. |
| SMI.Participant.Changed.Joined.Accessibility | %s has joined the conversation | Notice that a participant has joined the conversation. |
| SMI.Participant.Changed.Left | %s has left | Notice that a participant has joined the conversation. |
| SMI.Participant.Changed.Left.Accessibility | %s has left the conversation | The accessibility announcement that informs the user that a participant has left the conversation. |
| SMI.Participant.Name.Default | Participant | Default string for a participant with no display name or subject configured. |
| Keyword | Default Value | Description |
|---|
| SMI.Back.Button.Accessibility | Back to chat feed | Accessibility text for hitting the back button on pre-chat submission screen. |
| SMI.Checkbox.Not.Selected.Accessibility | Checkbox not selected | Accessibility text for when the checkbox isn’t selected. |
| SMI.Checkbox.Selected.Accessibility | Checkbox selected | Accessibility text for when the checkbox is selected. |
| SMI.Exit.Button.Accessibility | Exit to chat feed | Accessibility text for hitting the exit button on pre-chat submission screen. |
| SMI.Pre.Chat.Back.Button | Back | The back button for the pre-chat form. |
| SMI.Pre.Chat.Choice.List.None | None | Label for the None option in a pre-chat choice list. |
| SMI.Pre.Chat.Error.Field.Required | This field is required. | Error message shown when a required field fails pre-chat validation. |
| SMI.Pre.Chat.Error.Valid.Email.Format | Use a valid email format. | Error message shown when an email field fails pre-chat validation. |
| SMI.Pre.Chat.Error.Valid.Number.Format | Field can only contain numbers. | Error message shown when a number field fails pre-chat validation. |
| SMI.Pre.Chat.Error.Valid.Phone.Format | Use a valid phone number format. | Error message shown when a phone pre-chat field fails pre-chat validation. |
| SMI.Pre.Chat.Required | %s * | The string for a pre-chat field label if the field is required. |
| SMI.Pre.Chat.Required.Accessibility | %s is required | Accessibility text for the pre-chat field if the field is required. |
| SMI.Pre.Chat.Submission.Card.Title | Form submitted Tap to review | Text for pre-chat cell that shows in chat after submitting form. |
| SMI.Pre.Chat.Submission.Review.Title | Submitted Form Details | Header for pre-chat submitted form details. |
| SMI.Pre.Chat.Submit.Button | Chat with an Agent | The title of the pre-chat submit button. |
| SMI.Pre.Chat.Title | Just a few things before we connect you with an expert… | The title of the pre-chat form. |
| Keyword | Default Value | Description |
|---|
| SMI.Transcript.Alert.Save.Failed | Save failed | Message to display when the request transcript fails to save on the device. |
| SMI.Transcript.Alert.Save.Succeed | Save was successful | Message to display when a request transcript successfully saves on the device. |
| SMI.Transcript.Alert.Title | Save | The title of the alert that is shown after an attempt to save a request transcript on the device. |
| SMI.Transcript.Alert.Button.Title | Ok | The text for the confirm button in the alert shown after an attempt to save a request transcript on the device. |
| SMI.Transcript.Cancel.Button | Cancel | The cancel button on the leave transcript screen. This screen warns the user that if they leave without saving, the transcript is lost. |
| SMI.Transcript.Error.Message | Something went wrong. Please try again later. | Error message to display on the error screen when the transcript fails to download from the server. |
| SMI.Transcript.Leave.Button | Leave | The leave button on the leave transcript screen. This screen warns the user that if they leave without saving, the transcript is lost. |
| SMI.Transcript.Leave.Title | Leave Transcript | The title of the leave transcript screen. This screen warns the user that if they leave without saving, the transcript is lost. |
| SMI.Transcript.Leave.Subtitle | Be sure to save the transcript before leaving. | The subtitle of the leave transcript screen. This screen warns the user that if they leave without saving, the transcript is lost. |
| SMI.Transcript.Request.Button | Request Chat Transcript | The title of the request transcript button in the participant client menu. |
| SMI.Transcript.Save.Button.Accessibility | Save Transcript | The accessibility string for the save transcript button. |
| SMI.Transcript.Share.Button.Accessibility | Share Transcript | The accessibility string for the share transcript button. |
| SMI.Transcript.Title | Chat Transcript | The title of the request transcript screen. |
| Keyword | Default Value | Description |
|---|
| SMI.Routing.Initial.Agent | An agent will be with you shortly. | Shown when an estimated wait time is available and the routing type is in the initial state. |
| SMI.Routing.Failure.Event.Text | Agents aren’t available. Try again later. | A default system message informing the user that routing to an agent has failed. |
| SMI.Routing.Wait.Resolved.Minutes | Your expected wait time is %s minutes. | Shown when the estimated wait time is greater than 60 seconds. Rounded up to the nearest minute. |
| SMI.Routing.Wait.Resolved.Short | Your expected wait time is less than one minute. | Shown when the estimated wait time is less than or equal to 60 seconds. |
| Keyword | Default Value | Description |
|---|
| SMI.Form.Message.Back.Button | Back | The back button for the secure form. |
| SMI.Form.Message.Back.Button.Accessibility | Back to chat feed | The accessibility text for hitting the back button on Form Message submission screen. |
| SMI.Form.Message.Divider | %d/%d | The divider for the form message text field character counter. |
| SMI.Form.Message.Exit.Screen.Cancel | Cancel | The cancel button text for the secure form exit confirmation screen. |
| SMI.Form.Message.Exit.Screen.Confirm | Leave Form | The leave-form button for the secure form exit confirmation screen. |
| SMI.Form.Message.Exit.Screen.Subtitle | After leaving the form, you can open it again in the messaging window. However, your progress isn't saved. | The subtitle for the secure form exit confirmation screen. |
| SMI.Form.Message.Exit.Screen.Title | Leave the form | The main title for the secure form exit confirmation screen. |
| SMI.Form.Message.Footer.Back | Back | The text displayed in the footer menu of the Form Message for the back button. |
| SMI.Form.Message.Footer.Next | Next | The text displayed in the footer menu of the Form Message for the next button. |
| SMI.Form.Message.Footer.Submit | Submit | The text displayed in the footer menu of the Form Message for the submit button. |
| SMI.Form.Message.Option.Required.Message | One or more options required | The string that is displayed below a form entry that indicates that this item is required. |
| SMI.Form.Message.Required | % * | The string for a form message field label if the field is required. |
| SMI.Form.Message.Required.Accessibility | %@ is required | The accessibility string for the form message field if the field is required. |
| SMI.Form.Message.Result.Error | Error Submitting Form | The message shown in the chat bubble when a form fails to submit. |
| SMI.Form.Message.Result.Success | Form Submitted | The message shown in the chat bubble when a form has been successfully submitted. |
| SMI.Form.Message.Result.Submitting | Form Submitting | The message shown in the chat bubble when a form is submitting. |
| SMI.Form.Message.Text.Input.Required.Message | This field is required | The string that is displayed below a form entry that indicates that this item is required. |
| SMI.Form.Message.Text.Invalid.Email | Not a valid email | The string that is displayed below a form entry that indicates that an invalid email has been entered. |
| SMI.Form.Message.Text.Invalid.Url | Not a valid url | The string that is displayed below a form entry that indicates that an invalid url has been entered. |
| Keyword | Default Value | Description |
|---|
| SMI.Terms.And.Conditions.Accept | Accept | Message displayed next to the checkbox to accept the Terms and Conditions. |
| SMI.Terms.And.Conditions.Error | Accept the Terms and Conditions to continue. | Error message displayed when the Terms and Conditions are required but not accepted. |
| Keyword | Default Value | Description |
|---|
| SMI.Typing.Indicator.Accessibility | %@ is typing | The accessibility label for the agent typing indicator. |
| SMI.Typing.Indicator.Start.Accessibility | %@ has started typing | The accessibility announcement that informs the user when a participant starts typing. |
| SMI.Typing.Indicator.Stop.Accessibility | %@ has stopped typing | The accessibility announcement that informs the user when a participant stops typing. |