Also available in Russian
.package(url: "https://github.com/usedesk/UseDeskSPM.git", from: "1.3.0")Where * — required parameter
| Parameter | Type | Description |
|---|---|---|
| CompanyID* | String | Company ID in Usedesk How to find a company ID |
| ChannelID* | String | ID of the chat channel through which messages from the application will be placed at Usedesk How to create and set up a channel |
| Url* | String | Server URL for SDK chats By default: pubsubsec.usedesk.ruIf you use server version of Usedesk on your own server, value may be different for you. Check with our team for valid URL — support@usedesk.com |
| Port | String | Server port for SDK chats By default: 443 |
| UrlAPI* | String | URL to work with Usedesk API By default: secure.usedesk.ru/uapiIf you use server version of Usedesk on your own server, value may be different for you. Check with our team for valid URL — support@usedesk.com |
| API_token | String | Usedesk API Token How to get API Token |
| KnowledgeBaseID | String | Knowledge Base ID How to create a Knowledge Base If ID is not provided, Knowledge Base will not be used |
| UrlToSendFile | String | URL for sending files By default: https://secure.usedesk.ru/uapi/v1/send_file |
| Name | String | Client name |
| String | Client email | |
| Phone | String | Client phone |
| Avatar | Data? | Client avatar |
| AvatarUrl | URL? | URL of client avatar image Avatar parameter has higher priority |
| Token | String | A unique token that uniquely identifies the user and his conversation The token is provided in the callback after the initialization of the chat and is linked to the mail-phone-user name. To identify different users on the same device, you must store and pass the received token to the initialization method |
| AdditionalId | String | Additional customer ID |
| Note | String | Text of note |
| AdditionalFields | Int : String | Array of ticket additional fields Format: id : "value"For text fields the value is a string, for a list the value is a string with the exact list value, for a flag the value is a string false or true |
| AdditionalNestedFields | Int : String | Array of additional fields of nested list type Each subarray represents one nested list. Format of nested list: [id1: "value", id2 : "value", id3 : "value"], where id1, id2, id3 — value identifiers by nesting levels |
| FirstMessage | String | Automatic message Sent immediately after initialization on behalf of the client |
| CountMessagesOnInit | Int | Number of loaded messages when starting the chat When client open a chat, a specified number of messages are loaded. As client scrolls chat, 20 more messages are loaded |
| LocaleIdentifier | String | Language Identifier Available languages: Russian ( ru), English (en), Portugiese (pt), Spanish (es). If passed identifier is not supported, the Russian language will be used |
| CustomLocale | String : String | Your own translation dictionary If the SDK needs to be displayed in a language we do not support, you can create a translation dictionary yourself and use it |
| isSaveTokensInUserDefaults | Bool | The flag of automatic display of the controller in the specified parent controller By default: true |
let usedesk = UseDeskSDK()
usedesk.start(
companyID: "1234567",
chanelId: "1234",
url: "pubsubsec.usedesk.ru",
port: "443",
urlAPI: "pubsubsec.usedesk.ru",
api_token: "143ed59g90ef093s",
urlToSendFile: "https://secure.usedesk.ru/uapi/v1/send_file",
knowledgeBaseID: "12",
name: "Name",
email: "lolo@yandex.ru",
phone: "89000000000",
avatar: avatarData,
token: "Token",
additional_id: "additional_id",
note: "Note text",
additionalFields: [1 : "value"],
additionalNestedFields: [[1 : "value1", 2 : "value2", 3 : "value3"]],
firstMessage: "message",
сountMessagesOnInit: 30,
localeIdentifier: "en",
customLocale: customLocaleDictionary,
isSaveTokensInUserDefaults: true,
connectionStatus: { success, feedbackStatus, token in },
errorStatus: { udError, description in }
)СonnectionStatus
| Type | Description |
|---|---|
| Bool | Successful connection to the chat |
| UDFeedbackStatus | Feedback form display status |
| String | User token |
ErrorStatus
| Type | Description |
|---|---|
| UDError | Documented error type |
| String? | Error description |
Methods for working with the SDK, customization of elements, and errors are described in our documentation: https://sdk.usedocs.com
Sergey, kon.sergius@gmail.com
UseDesk_SDK_Swift is available under the MIT license. See the LICENSE file for more info