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:

UI SDKCore SDK

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.

KeywordDefault ValueDescription
SMI.Chat.Feed.TitleChatTitle for the chat feed view.
SMI.Chat.Feed.AccessibilityChat FeedAccessibility label for the chat feed container view.
SMI.Chat.Start.ConversationStart ConversationContent description for a button that is used to resubmit pre-chat fields mid-conversation.
SMI.Chat.Start.Conversation.Feed.Input.Text.AccessibilityFill out a pre-chat form to continue the conversationAccessibility announcement when the user needs to enter and resubmit pre-chat fields.
SMI.Chat.Badge.Overlay.Count9+The chat feed badge overlay unread message count for amounts equal to or over 10.
KeywordDefault ValueDescription
SMI.Feed.Input.TextType a messagePlaceholder text inside chat input field.
SMI.Feed.Input.Text.AccessibilityMessage InputAccessibility label for identifying the input control.
SMI.Feed.Input.ButtonSendAction text for the send message button.
SMI.Feed.New.MessagesNew MessagesA notification that alerts the user that there are new unread messages in the chat feed.
SMI.Feed.New.Messages.AccessibilityYou 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.AccessibilityScroll to bottom of chat feed.The description for the notification badge button that alerts a user they will be brought to the bottom of the feed.
KeywordDefault ValueDescription
SMI.Feed.Action.Menu.TitleSend an attachment?Action Menu text for sending a photo.
SMI.Feed.Action.Menu.Photo.SendSend a PhotoAction Menu text for sending a photo.
SMI.Feed.Action.Menu.File.SendSend a FileAction Menu text for sending a file.
SMI.Feed.Action.Menu.Photo.TakeTake a PhotoAction Menu text for taking a photo.
SMI.Feed.Action.Menu.AccessibilityAction MenuThe accessibility string for the Action Menu to the left of the text input
KeywordDefault ValueDescription
SMI.Delivery.Timestamp.YesterdayYesterday • %@The message auxiliary view that will display the time information for the day yesterday with the timestamp.
SMI.Delivery.Timestamp.TodayToday • %@The message auxiliary view that will display the time information for the day today with the timestamp.
SMI.Delivery.Status.SendingSendingThe message auxiliary view that will display the sending message indicator.
SMI.Delivery.Status.SentSentThe message auxiliary view that will display the sent message indicator.
SMI.Delivery.Status.ReadReadThe message auxiliary view that will display the read message indicator.
SMI.Delivery.Status.DeliveredDeliveredThe message auxiliary view that will display the delivered message indicator.
SMI.Delivery.Status.ErrorSend failed. Tap to retry.The message auxiliary view that will display the error message.
SMI.Delivery.Status.Error.Additional.Information.RequiredProvide 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.AccessibilityFailedThe concise failed status for accessibility
SMI.Delivery.Status.Error.Hint.AccessibilityDouble tap to retryHint for the user to double tap the message to retry
SMI.Local.Message.Identifier.AccessibilityYour Message %@The accessibility text for identifying messages sent from the local user
SMI.Remote.Message.Identifier.Accessibility%1$@ message %2$@The accessibility text for identifying messages sent from the remote user. %1$s is the name of the agent, %2$s will represent the message.
SMI.System.Message.Identifier.AccessibilitySystem message %@The accessibility text for identifying messages sent from the system user
SMI.Message.Received.Event.AccessibilityMessage received from %@The accessibility announcement text that informs the user when a message has been received
SMI.Message.Sending.Event.AccessibilityMessage sentThe accessibility announcement text that informs the user that their message has been sent
KeywordDefault ValueDescription
SMI.Network.Status.ReconnectingWaiting to reconnectThe network connectivity banner text that will inform the user the network connection has been lost and is attempting to reconnect
SMI.Network.Status.Reconnecting.AccessibilityNetwork connectivity is lost, attempting to reconnectThe accessibility announcement that informs the user when the network connection has been lost and is attempting to reconnect
SMI.Network.Status.ConnectedConnectedThe network connectivity banner that will inform the user the network has connected after the network has lost connectivity
SMI.Network.Status.Connected.AccessibilityNetwork connectivity establishedThe accessibility announcement that informs the user when the network is connected after having lost connectivity
KeywordDefault ValueDescription
SMI.Business.Hours.OutsideNew chats aren't available outside of business hoursThe message that is shown in the chat feed banner when outside of business hours
SMI.Business.Hours.Outside.AccessibilityNew 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
KeywordDefault ValueDescription
SMI.Typing.Indicator.Start.Accessibility%@ has started typingThe accessibility announcement that informs the user when a participant starts typing
SMI.Typing.Indicator.Stop.Accessibility%@ has stopped typingThe accessibility announcement that informs the user when a participant stops typing
SMI.Typing.Indicator.Accessibility%@ is typingThe accessibility label for the agent typing indicator
KeywordDefault ValueDescription
SMI.Progress.Indicator.Single.Participant%@ is typing...The default label for a single participant progress indicator.
SMI.Progress.Indicator.Bot%@ is responding...The default label for a bot progress indicator.
SMI.Progress.Indicator.Two.Participants%1$@ and %2$@ are typing...The default label for two participants typing.
SMI.Progress.Indicator.Multiple.ParticipantsMultiple people are typing...The default label for multiple participants typing.
SMI.Progress.Indicator.Message.Accessibility%1$@ %2$@The accessibility announcement for a bot progress indicator containing the bot display name and the progress message text.
KeywordDefault ValueDescription
SMI.Misc.Separatorseparator used when conjoining information together in a string
SMI.Misc.UnknownUnknownThis is used when a value or result cannot be determined
SMI.Action.CancelCancelCancel action to be used for cancel button and menus throughout the SDK.
SMI.Action.SettingsSettingsSettings action for permission alerts
SMI.File.Size.MegabyteMBSize of a file in megabytes
SMI.Unknown.Entry.MessageThis message type isn't supported.The error message that appears when the message type of the message in the chat feed isn't supported.
KeywordDefault ValueDescription
SMI.Alert.Title.FailedMessage FailedAlert title text for the retry message alert.
SMI.Alert.Title.Permission.CameraAllow Camera AccessAlert title text for requesting camera access.
SMI.Alert.Message.FailedMessage failed to send. Retry?Confirmation text for the retry message alert.
SMI.Alert.Message.Permission.CameraTo use your camera, go to Settings and enable Camera access for this app.Explanation that the user must allow camera permission
SMI.Alert.Action.RetryRetryRetry action for the retry message alert.
SMI.Alert.Attachment.Limit.ReachedAttachment limit reachedAlert when limit for number of attachments is reached.
KeywordDefault ValueDescription
SMI.Participant.Name.DefaultParticipantDefault string for a participant with no displayName or subject configured.
SMI.Participant.Changed.Joined%@ has joinedNotice that a participant has joined the conversation
SMI.Participant.Changed.Joined.Accessibility%@ has joined the conversationThe accessibility announcement that informs the user that a participant has joined the conversation
SMI.Participant.Changed.Left%@ has leftNotice that a participant has left the conversation
SMI.Participant.Changed.Left.Accessibility%@ has left the conversationThe accessibility announcement that informs the user that a participant has left the conversation
KeywordDefault ValueDescription
SMI.Pre.Chat.Required.Accessibility%@ is requiredThe accessibility string for the PreChat field if the field is required
SMI.Pre.Chat.Required%@ *The string for a PreChat field label if the field is required
SMI.Pre.Chat.Submit.ButtonChat with an AgentThe title of the PreChat submit button
SMI.Pre.Chat.TitleJust a few things before we connect you with an expert…The title of the PreChat forum
SMI.Pre.Chat.Choice.List.NoneNoneLabel for the None option in a pre-chat choice list
SMI.Pre.Chat.Back.ButtonBackThe back button for the prechat form
SMI.Pre.Chat.Error.Field.RequiredThis field is required.Error message shown when a required field fails PreChat validation
SMI.Pre.Chat.Error.Valid.Email.FormatUse a valid email format.Error message shown when an email PreChat field fails PreChat validation
SMI.Pre.Chat.Error.Valid.Number.FormatField can only contain numbers.Error message shown when a number PreChat field fails PreChat validation
SMI.Pre.Chat.Error.Valid.Phone.FormatUse a valid phone number format.Error message shown when a phone PreChat field fails PreChat validation
SMI.Pre.Chat.Submission.Review.TitleSubmitted Form DetailsHeader for prechat submitted form details
SMI.Pre.Chat.Submission.Card.TitleForm submitted Tap to reviewText for prechat cell that shows in chat after submitting prechat
SMI.Back.Button.AccessibilityBack to chat feedAccessibility text for hitting the back button on pre chat submission screen
SMI.Exit.Button.AccessibilityExit to chat feedAccessibility text for hitting the exit button on pre chat submission screen
SMI.Checkbox.Selected.AccessibilityCheckbox selectedAccessibility text for when the checkbox is selected
SMI.Checkbox.Not.Selected.AccessibilityCheckbox not selectedAccessibility text for when the checkbox is not selected
SMI.Terms.And.Conditions.ErrorAccept the Terms and Conditions to continue.Error message displayed when the Terms and Conditions are required but not accepted.
SMI.Terms.And.Conditions.AcceptAcceptMessage displayed next to the checkbox to accept the Terms and Conditions.
SMI.Terms.And.Conditions.Accepted.AccessibilityTerms and conditions is acceptedAccessibility label for terms and conditions box when it is accepted.
SMI.Terms.And.Conditions.Not.Accepted.AccessibilityTerms and conditions is not acceptedAccessibility label for terms and conditions box when it is accepted.
SMI.Pre.Chat.Error.Accessibility%1$@ input. Error %2$@.Accessibility readout for prechat errors. The first parameter is the field name, the second field is the error on the field.
KeywordDefault ValueDescription
SMI.Image.AccessibilityImage message.Accessibility text for an image message in the chat feed or attachment preview.
SMI.Remove.Image.Button.AccessibilityRemove image message.Accessibility text for the button to remove an image message from the input field.
SMI.Multiple.Attachment.Counter+%dA counter that takes an integer representing the number of file attachments not shown.
SMI.Image.Preview.AccessibilityImage preview.Accessibility text for the image preview dialog.
SMI.Image.Preview.Cancel.Button.AccessibilityClose image preview.Accessibility text for the button to close the image preview dialog.
SMI.Camera.Gallery.Button.AccessibilityPhoto gallery.Accessibility text for the button to open the photo gallery.
SMI.Camera.Switch.Lens.Button.AccessibilitySwitch lens direction.Accessibility text for the button to switch the camera lens direction.
SMI.Camera.Capture.Button.AccessibilityCapture photo.Accessibility text for the button to capture a photo.
SMI.Camera.View.Capturing.AccessibilityCamera capturing photoAccessibility text for the view that is displaying the phones camera capturing a photo
SMI.Image.Viewer.Jump.To.Photo.AccessibilityJump to photoAccessibility text for the jump to photo button in image viewer
SMI.Image.Viewer.Share.Photo.AccessibilityShare photoAccessibility text for the share button in image viewer
SMI.Image.Viewer.Download.Photo.AccessibilityDownload photoAccessibility text for the download button in image viewer
SMI.Header.Share.Image.ViewerImageShown when user taps the share button while viewing an image in the attachment viewer screen
SMI.Header.Share.Gif.ViewerGIFShown when user taps the share button while viewing a GIF in the attachment viewer screen
SMI.Header.Share.Pdf.ViewerPDFShown when user taps the share button while viewing a PDF in the attachment viewer screen
SMI.Image.Saved.MessageAttachment savedShown in popup when user taps the download button and the attachment successfully saves
SMI.Attachment.Download.Failed.MessageFailed to save attachmentShown in popup when user clicks on download button and the attachment fails to save
SMI.Image.Download.Denied.TitleAllow Photo AccessTitle shown in popup when user tries to save a photo with denied permission
SMI.Image.Download.Denied.BodyTo save photos, go to Settings and enable Photos access for this app.Message shown in popup when user tries to save a photo with denied permission
SMI.File.Format.UnsupportedUnsupported file format.Message shown if user sends an unsupported file in chat
SMI.File.Size.ExceededAttachment is too large. Maximum size is %@.Message shown if the user sends an attachment that exceeds the max size that can be sent
KeywordDefault ValueDescription
SMI.Transfer.Requested.Event.TextTransfer requested at %@A system message informing the user that a transfer to a service agent has been requested, and a string template indicating the time of the request.
KeywordDefault ValueDescription
SMI.Routing.Failure.Event.TextAgents are not available. Try again later.A default system message informing the user that routing to a service console agent has failed.
KeywordDefault ValueDescription
SMI.Routing.Initial.AgentAn agent will be with you shortly.Shown when the routing type is initial. and EWT is available
SMI.Routing.Wait.Resolved.MinutesYour expected wait time is %@ minutes.Shown when the estimated wait time is greater than 60 seconds. Rounded up to the nearest minute
SMI.Routing.Wait.Resolved.ShortYour expected wait time is less than one minute.Shown when the estimated wait time is less than or equal to 60 seconds
KeywordDefault ValueDescription
SMI.Loading.Screen.AccessibilityActive loading screenA message that will be read out to the user when a loading screen is shown, and read out to the user when the loading screen is selected.
KeywordDefault ValueDescription
SMI.Link.Preview.AccessibilityLink previewThe screen reader will read out link preview and then the name of the link
KeywordDefault ValueDescription
SMI.Nothing.Entered.In.SearchNothing here yetMessage displayed when there’s nothing in the search bar and there are no recent searches
SMI.No.Search.ResultsNo search resultsMessage displayed when there are no search results
SMI.No.Matching.ResultsWe couldn't find what you're looking for. Try searching for something else.Message displayed when nothing matches the users search
SMI.Message.Search.HeaderMessage SearchHeader for the message search page
SMI.Recent.Searches.HeaderRecent SearchesHeader for the recent search list
SMI.Search.Placeholder.TextSearchPlaceholder text for the search bar
SMI.Today.Timestamp.Message.SearchTodayTimestamp text for when the message was sent today
SMI.Yesterday.Timestamp.Message.SearchYesterdayTimestamp text for when the message was sent yesterday
SMI.Users.NameYouThe name shown for the user in the time stamp row
SMI.No.Recent.SearchesYou 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.Message.Search.Back.ButtonBackThe back button for message search
SMI.Message.Search.Clear.Search.Text.AccessibilityClear search textAccessibility text for clearing the search field in message search
SMI.Message.Search.Agent.Avatar.AccessibilityAgent avatarAccessibility text for the agent avatar in message search
SMI.Message.Search.User.Avatar.AccessibilityUser avatarAccessibility text for the user avatar in message search
SMI.Message.Search.Agent.Bot.AccessibilityBot avatarAccessibility text for the bot avatar in message search
KeywordDefault ValueDescription
SMI.Action.CopyCopyText displayed in the context menu for the copy behavior
SMI.Action.Copy.AttachmentCopy AttachmentText displayed in the context menu for copying an attachment when receiving part of a conversation entry with text and an attachment
SMI.Action.Copy.TextCopy TextText displayed in the context menu for copying text when receiving part of a conversation entry with text and an attachment
KeywordDefault ValueDescription
SMI.Participant.Client.Menu.TitleConversation OptionsText displayed in the header of the participant client menu. The participant client menu will contain actions a user can take in a chat feed. The header will display the name of the participant followed by Options.
SMI.Participant.Client.Menu.Title.AccessibilityConversation Options MenusThe accessibility message for the participant client menu
KeywordDefault ValueDescription
SMI.Form.Message.Footer.SubmitSubmitText displayed in the footer menu of the Form Message for the submit button.
SMI.Form.Message.Footer.BackBackText displayed in the footer menu of the Form Message for the back button.
SMI.Form.Message.Footer.NextNextText displayed in the footer menu of the Form Message for the next button.
SMI.Form.Message.Back.ButtonBackThe back button for the secure form
SMI.Form.Message.Back.Button.AccessibilityBack to chat feedAccessibility text for hitting the back button on form message submission screen
SMI.Form.Message.Exit.Screen.TitleLeave the form?The main title for the secure form exit confirmation screen.
SMI.Form.Message.Exit.Screen.SubtitleAfter 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.ConfirmLeave FormThe leave form button for the secure form exit confirmation screen.
SMI.Form.Message.Exit.Screen.CancelCancelThe cancel button text for the secure form exit confirmation screen
SMI.Form.Message.Result.SuccessForm SubmittedThe message shown in the chat bubble when a form has been successfully submitted.
SMI.Form.Message.Result.SubmittingForm SubmittingThe message shown in the chat bubble when a form is submitting.
SMI.Form.Message.Result.ErrorError Submitting FormThe message shown in the chat bubble when a form fails to submit.
SMI.Form.Message.Required.Accessibility%@ is requiredThe accessibility string for the form message field if the field is required
SMI.Form.Message.Required%@ *The string for a form message field label if the field is required
SMI.Form.Message.Text.Invalid.EmailNot a valid emailThe string that is displayed below a form entry that indicates an invalid email has been entered.
SMI.Form.Message.Text.Invalid.UrlNot a valid urlThe string that is displayed below a form entry that indicates an invalid url has been entered.
SMI.Form.Message.Text.Input.Required.MessageThis field is requiredThe string that is displayed below a form entry that indicates this item is required.
SMI.Form.Message.Option.Required.MessageOne or more options requiredThe string that is displayed below a form entry that indicates this item is required.
SMI.Form.Message.Divider%1$d/%2$dThe divider for the form message text field character counter
SMI.Form.Message.Text.Input.Accessibility%@ double tap to editThe accessibility message for the grouped form text input
SMI.Form.Message.Text.Input.Required.Accessibility%@ is required. Double tap to editThe accessibility message for the group form text required input
SMI.Form.Message.Screen.Accessibility%@ ScreenThe accessibility message is shown when a new screen is displayed in the form input
SMI.Form.Message.Option.Selected.Accessibility%@ option selectedThe accessibility message for a selected option in the form options menu
SMI.Form.Error.Accessibility%1$@ input. Error %2$@.Accessibility readout for form errors. The first parameter is the form field label. The second parameter is the error message on the field.
KeywordDefault ValueDescription
SMI.Carousel.Image.Placeholder.AccessibilityEmpty Carousel imageA placeholder icon to indicate there is no image for a carousel option.
SMI.Carousel.Selected.Icon.AccessibilityOption selectedAn icon to indicate that an option has been selected for a carousel message.
SMI.Carousel.Image.AccessibilityCarousel imageThe default image content description for a carousel option, if no description is given.
SMI.Carousel.Indicator.AccessibilityPage %1$d of %2$dAccessibility label for the carousel indicator
SMI.Carousel.Indicator.Dot.AccessibilityGo to page %1$d of %2$dAccessibility label for individual carousel indicator dots
KeywordDefault ValueDescription
SMI.Transcript.Request.ButtonRequest Chat TranscriptThe title of the request transcript button in the participant client menu.
SMI.Transcript.TitleChat TranscriptThe title of the request transcript screen.
SMI.Transcript.Leave.ButtonLeaveThe leave button on the leave transcript screen. This screen warns the user that if they leave without saving, the transcript is lost.
SMI.Transcript.Cancel.ButtonCancelThe cancel button on the leave transcript screen. This screen warns the user that if they leave without saving, the transcript is lost.
SMI.Transcript.Leave.TitleLeave TranscriptTitle of the leave transcript screen. This screen warns the user that if they leave without saving, the transcript is lost.
SMI.Transcript.Leave.SubtitleBe sure to save the transcript before leaving.Subtitle of the leave transcript screen. This screen warns the user that if they leave without saving, the transcript is lost.
SMI.Transcript.Save.Button.AccessibilitySave TranscriptThe accessibility string for the save transcript button.
SMI.Transcript.Share.Button.AccessibilityShare TranscriptThe accessibility string for the share transcript button.
SMI.Transcript.Error.MessageSomething 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.Alert.Save.FailedSave failedMessage to display when the request transcript fails to save on the device.
SMI.Transcript.Alert.Save.SucceedSave was successfulMessage to display when a request transcript successfully saves on the device.
SMI.Transcript.Alert.TitleSaveThe title of the alert that is shown after an attempt to save a request transcript on the device.
SMI.Transcript.Alert.Button.TitleOkThe text for the confirm button in the alert shown after an attempt to save a request transcript on the device.
SMI.Transcript.Back.AccessibilityBack to options menuAccessibility text for the back button in request transcripts.
KeywordDefault ValueDescription
SMI.End.Chat.Menu.ButtonEnd ChatThe title of the end chat button in the participant client menu.
SMI.End.Chat.TitleEnd Chat?The title label on the end chat confirmation page.
SMI.End.Chat.SubtitleAre you sure you want to end the chat session? You will be disconnected from the agent.The subtitle label on the end chat confirmation page.
SMI.End.Chat.Confirmation.ButtonEnd ChatThe end chat button label on the confirmation page.
SMI.End.Chat.CancelCancelThe cancel button label on the confirmation page.
SMI.End.Chat.Error.MessageSomething went wrong. Please try again later.Error message to display on the end chat confirmation page when there is an issue ending the chat
SMI.Fallback.Message.Close.ButtonCloseThe close button label on the fallback message page.
KeywordDefault ValueDescription
SMI.Streaming.Text.CursorThe cursor to display while text is streaming in.
SMI.Streaming.Message.AccessibilityThe bot is respondingAccessibility readout for when a message is being streamed in.
SMI.Citation.Inline.Title\[%d\]A string template for inline citations. Takes an integer representing the citation number.
SMI.Citation.Source.Button.Title[%1$d] %2$@A string template for citation source button. Takes an integer representing the citation number and a string representing the url title