Sunshine Conversations

https://docs.smooch.io
Admin
Sunshine Conversations is a cloud platform that enables businesses to communicate with customers...
Tokens:134,369
Snippets:1,731
Trust Score:9.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Dependencies

Source: https://docs.smooch.io/guide/web-messenger

Initialize the project and install the necessary packages for Sunshine Conversations and webpack.

```bash
$ npm install smooch
$ npm init -y
$ npm i webpack webpack-cli webpack-dev-server --save-dev
```

--------------------------------

### Install Webpack Dev Server

Source: https://docs.smooch.io/guide/web-messenger

Install the development server for local testing.

```bash
$ npm i webpack-dev-server --save-dev
```

--------------------------------

### List Apps Query Example

Source: https://docs.smooch.io/rest?javascript=

Example of a paginated request to list apps using cursor pagination parameters.

```text
/v2/apps?page[after]=5e1606762556d93e9c176f69&page[size]=10
```

--------------------------------

### Launch Activity

Source: https://docs.smooch.io/api/android/io/smooch/features/conversationlist/ConversationListActivityBuilder.html

Starts the activity using the provided context.

```java
public	void	show(android.content.Context	context)
```

--------------------------------

### Install Pods

Source: https://docs.smooch.io/guide/native-ios-sdk

Command to install the dependencies defined in your Podfile after adding the Smooch pod.

```bash
$ pod install
```

--------------------------------

### show(Context context)

Source: https://docs.smooch.io/api/android/io/smooch/ui/ConversationActivityBuilder.html

Starts the ConversationActivity with the specified configuration.

```APIDOC
### Method
`public void show(android.content.Context context)`

### Description
Starts the ConversationActivity with the specified configuration.

### Parameters
- **context** (android.content.Context) - The Context from which Context.startActivity(Intent) will be invoked.
```

--------------------------------

### Get User Response Sample

Source: https://docs.smooch.io/rest?javascript=

Example JSON response returned when successfully fetching an individual user.

```json
{
  "user": {
    "id": "67a11490f0305f4a391e9f8a",
    "externalId": "your-own-id",
    "zendeskId": "35436",
    "brandId": "9477922990333",
    "signedUpAt": "2025-02-03T19:10:08.152Z",
    "hasPaymentInfo": false,
    "identities": [ ],
    "profile": {
      "locale": "en",
      "localeOrigin": "zendeskAccount"
},
    "metadata": { }
}

}
```

--------------------------------

### Install Carthage

Source: https://docs.smooch.io/guide/native-ios-sdk

Command to install Carthage using Homebrew if it is not already installed.

```bash
$ brew install carthage
```

--------------------------------

### Accessing Signup Date

Source: https://docs.smooch.io/api/ios/Classes/SKTUser.html

Gets or sets the date the user started using the service.

```Objective-C
@property (copy, nullable) NSDate *signedUpAt;
```

```Swift
var signedUpAt: Date? { get set }
```

--------------------------------

### Display Conversation with Starting Text (Swift)

Source: https://docs.smooch.io/guide/native-ios-sdk

Display the conversation interface and prefill the text box with a starting message. Replace the example text with your desired starting message.

```swift
Smooch.show(withStartingText: "Hi there! Can you help me please?")
```

--------------------------------

### Install CocoaPods

Source: https://docs.smooch.io/guide/native-ios-sdk

Command to install CocoaPods if it is not already present on your system.

```bash
$ sudo gem install cocoapods
```

--------------------------------

### Display Conversation with Starting Text (Objective-C)

Source: https://docs.smooch.io/guide/native-ios-sdk

Display the conversation interface and prefill the text box with a starting message. Replace the example text with your desired starting message.

```objective-c
[Smooch showWithStartingText:@"Hi there! Can you help me please?"];
```

--------------------------------

### Get Integration Response Sample

Source: https://docs.smooch.io/rest?javascript=

Example JSON response structure returned when successfully retrieving an integration.

```json
{
  "integration": {
    "id": "5e4af71a81966cfff3ef6550",
    "type": "android",
    "status": "active",
    "displayName": "Android SDK"
}

}
```

--------------------------------

### Get Device Response JSON

Source: https://docs.smooch.io/rest?javascript=

Example of a successful 200 OK response containing the device object and its associated metadata.

```json
{
  "device": {
    "id": "5d9b870dda96abc332625ccc",
    "guid": "f1c7abea2d49429db10094be820d5f80",
    "clientId": "5d9b870dda96abc332625cc8",
    "integrationId": "5d83a25d9916b64a83ed25e8",
    "type": "web",
    "status": "active",
    "info": {
      "currentTitle": "My Web Page",
      "currentUrl": "https://example.com",
      "browserLanguage": "en-US",
      "referrer": "https://example.com",
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/132.0.0.0 Safari/537.36",
      "URL": "example.com",
      "sdkVersion": "0.1",
      "vendor": "zendesk"
    },
    "lastSeen": "2025-01-28T17:59:58.331Z"
  }
}
```

--------------------------------

### Example package.json Structure

Source: https://docs.smooch.io/guide/web-messenger

A sample package.json file showing the required scripts and dependencies.

```json
{
    "name": "web-messenger-webpack",
    "version": "1.0.0",
    "description": "",
    "main": "index.js",
    "scripts": {
        "test": "echo \"Error: no test specified\" && exit 1",
        "dev": "webpack --mode development"
        },
    ...
```

--------------------------------

### Install HTML Webpack Plugin

Source: https://docs.smooch.io/guide/web-messenger

Install the plugin to simplify HTML file generation for webpack bundles.

```bash
$ npm i html-webpack-plugin --save-dev
```

--------------------------------

### show(android.content.Context context)

Source: https://docs.smooch.io/api/android/io/smooch/features/conversationlist/ConversationListActivityBuilder.html

Starts the ConversationListActivity with the specified configuration.

```APIDOC
### Method
`public void show(android.content.Context context)`

### Description
Starts the ConversationListActivity with the specified configuration.

### Parameters
- **context** (android.content.Context) - The Context from which Context.startActivity(Intent) will be invoked.
```

--------------------------------

### Create Client Response Sample

Source: https://docs.smooch.io/rest?javascript=

Example response returned upon successfully creating a client.

```json
{
  "client": {
    "id": "67a11639f0305f4a391ea02d",
    "integrationId": "5e8b49d936c1df272e8e1460",
    "type": "whatsapp",
    "status": "pending"
}

}
```

--------------------------------

### Install Carthage Dependency

Source: https://docs.smooch.io/guide/native-ios-sdk

Add the Smooch framework URL to your Cartfile to manage the SDK dependency with Carthage. Ensure Carthage is installed.

```plaintext
binary "https://raw.githubusercontent.com/zendesk/sunshine-conversations-ios/master/Smooch.json"
```

--------------------------------

### Get Conversation Response Example

Source: https://docs.smooch.io/rest

Example JSON response body returned when successfully fetching a conversation.

```json
{
  * "conversation": {
    * "id": "67a0ecf8f0305f4a391e9db1",
    * "type": "personal",
    * "isDefault": false,
    * "lastUpdatedAt": "2025-02-03T16:21:12.308Z",
    * "createdAt": "2025-02-03T16:21:12.308Z"
}

}
```

--------------------------------

### List Switchboards Response Example

Source: https://docs.smooch.io/rest?javascript=

Example JSON response structure for a successful request to list all switchboards.

```json
{
  "switchboards": [
    {
      "id": "5ef21b132f21af34f088530d",
      "enabled": false
    }
  ]
}
```

--------------------------------

### Install CocoaPods Dependency

Source: https://docs.smooch.io/guide/native-ios-sdk

Add the Smooch dependency to your Podfile to install the SDK using CocoaPods. Ensure CocoaPods is installed first.

```ruby
pod 'Smooch'
```

--------------------------------

### Create Integration Response Sample

Source: https://docs.smooch.io/rest?javascript=

Example response returned upon successful creation of an integration.

```json
{
  "integration": {
    "id": "5e4af71a81966cfff3ef6550",
    "type": "android",
    "status": "active",
    "displayName": "Android SDK"
  }
}
```

--------------------------------

### Send a Message Example

Source: https://docs.smooch.io/api/android/io/smooch/core/Conversation.html

Demonstrates how to send a message using the current conversation instance.

```java
Smooch.getConversation().sendMessage(new Message("Hello World!"));
```

--------------------------------

### Create App Response Example

Source: https://docs.smooch.io/rest?javascript=

Successful 201 response containing the created app object.

```json
{
  "app": {
    "id": "67a0e55ef0305f4a391e9d69",
    "displayName": "My Test App",
    "settings": {
      "appLocalizationEnabled": true,
      "echoPostback": false,
      "maskCreditCardNumbers": true,
      "multiConvoEnabled": false,
      "useAnimalNames": false
}
}

}
```

--------------------------------

### Final package.json Configuration

Source: https://docs.smooch.io/guide/web-messenger

The complete package.json file including start scripts and dependencies.

```json
{
    "name": "web-messenger-webpack",
    "version": "1.0.0",
    "description": "",
    "main": "index.js",
    "scripts": {
        "test": "echo \"Error: no test specified\" && exit 1",
        "dev": "webpack --mode development",
        "start": "webpack serve --open 'Google Chrome'"
    },
    "keywords": [],
    "author": "",
    "license": "ISC",
    "dependencies": {
        "smooch": "^5.3.4"
    },
    "devDependencies": {
        "html-webpack-plugin": "^5.3.2",
        "webpack": "^5.41.1",
        "webpack-cli": "^4.7.2"
    }
}
```

--------------------------------

### startConversation

Source: https://docs.smooch.io/api/ios/Classes/Smooch.html

Starts a conversation for the current user.

```APIDOC
## startConversation

### Description
Starts a conversation for the current user.

### Signature
Objective-C: `+ (void)startConversationWithCompletionHandler:(nullable void (^)(NSError *_Nullable, NSDictionary *_Nullable))completionHandler;`
Swift: `class func startConversation() async throws -> [AnyHashable : Any]`
```

--------------------------------

### Start Conversation

Source: https://docs.smooch.io/api/ios/Classes/Smooch.html

Initiates a conversation session for the current user.

```Objective-C
+ (void)startConversationWithCompletionHandler:
    (nullable void (^)(NSError *_Nullable,
                       NSDictionary *_Nullable))completionHandler;
```

```Swift
class func startConversation() async throws -> [AnyHashable : Any]
```

--------------------------------

### Set User Sign-up Date

Source: https://docs.smooch.io/api/android/io/smooch/core/User.html

Sets the date the user started using the service.

```java
public void setSignedUpAt(java.util.Date signedUpAt)
```

--------------------------------

### Show Conversation Activity

Source: https://docs.smooch.io/api/android/io/smooch/ui/ConversationActivityBuilder.html

Starts the conversation activity using the provided context.

```java
public void show(android.content.Context context)
```

--------------------------------

### Get User Sign-up Date

Source: https://docs.smooch.io/api/android/io/smooch/core/User.html

Retrieves the date the user signed up.

```java
public java.util.Date getSignedUpAt()
```

--------------------------------

### withStartingText(String startingText)

Source: https://docs.smooch.io/api/android/io/smooch/ui/ConversationActivityBuilder.html

Specifies the starting text used to pre-fill the conversation activity text box.

```APIDOC
### Method
`public ConversationActivityBuilder withStartingText(String startingText)`

### Description
Specifies the starting text used to pre-fill the conversation activity text box.

### Parameters
- **startingText** (String) - The starting text to display.

### Returns
- **ConversationActivityBuilder** - The builder instance.
```

--------------------------------

### init(Application, Settings, SmoochCallback)

Source: https://docs.smooch.io/api/android/io/smooch/core/Smooch.html

Initializes the Smooch SDK with the provided settings.

```APIDOC
## static void init(android.app.Application application, Settings settings, SmoochCallback<InitializationStatus> callback)

### Description
Initialize the Smooch SDK with the provided settings.

### Parameters
- **application** (android.app.Application) - Required - The application instance.
- **settings** (Settings) - Required - The SDK settings.
- **callback** (SmoochCallback<InitializationStatus>) - Required - Callback to handle initialization status.
```

--------------------------------

### Get Webhook Response Example

Source: https://docs.smooch.io/rest?javascript=

The JSON structure returned when retrieving details for a specific webhook by its ID.

```json
{
  "webhook": {
    "id": "5e554d2cac66fb73a3c01871",
    "version": "v2",
    "target": "https://example.com/callback",
    "triggers": [
      "conversation:read",
      "conversation:message"
    ],
    "secret": "8564b3e6a8b20a4bdb68b05ce9bc5936",
    "includeFullUser": false,
    "includeFullSource": false
  }
}
```

--------------------------------

### init(Application, Settings, SmoochCallback)

Source: https://docs.smooch.io/api/android/io/smooch/core/Smooch.html

Initializes the Smooch SDK with the provided settings. This must be called from Application.onCreate().

```APIDOC
## public static void init(android.app.Application application, Settings settings, SmoochCallback<InitializationStatus> callback)

### Description
Initialize the Smooch SDK with the provided settings. This may only be called from Application.onCreate(), unless init(Application) was called there.

### Parameters
- **application** (android.app.Application) - The Application instance.
- **settings** (Settings) - The Settings to use for initialization.
- **callback** (SmoochCallback<InitializationStatus>) - Optional callback to be notified of the result.
```

--------------------------------

### Custom HTML Tag for Google Tag Manager

Source: https://docs.smooch.io/faq/web-messenger

Use a 'Custom HTML Tag' in Google Tag Manager to integrate the web widget. This example shows the basic setup.

```html
<script src="https://unpkg.com/smooch@latest/dist/smooch.js"></script>
<script>
  Smooch.init({
    "integrationId": "YOUR_INTEGRATION_ID"
  });
</script>
```

--------------------------------

### Create User Response Sample

Source: https://docs.smooch.io/rest?javascript=

Example JSON response returned upon successfully creating a user.

```json
{
  "user": {
    "id": "67a11490f0305f4a391e9f8a",
    "externalId": "your-own-id",
    "brandId": "9477922990333",
    "signedUpAt": "2025-02-03T19:10:08.152Z",
    "hasPaymentInfo": false,
    "identities": [ ],
    "profile": {
      "locale": "en",
      "localeOrigin": "zendeskAccount"
},
    "metadata": { }
}
}
```

--------------------------------

### List Clients Response Sample

Source: https://docs.smooch.io/rest?javascript=

Example of a successful 200 OK response containing a list of client objects and metadata.

```json
{
  "clients": [
    {
      "id": "67a0ee38f0305f4a391e9def",
      "type": "sdk",
      "status": "active",
      "lastSeen": "2025-02-03T16:26:32.575Z",
      "linkedAt": "2025-02-03T16:26:32.575Z"
    }
  ],
  "meta": {
    "hasMore": false
  }
}
```

--------------------------------

### GET /v2/apps/{appId}/keys

Source: https://docs.smooch.io/rest?javascript=

Lists all API keys for a given app.

```APIDOC
## GET /v2/apps/{appId}/keys

### Description
Lists all API keys for a given app.

### Method
GET

### Endpoint
/v2/apps/{appId}/keys

### Parameters
#### Path Parameters
- **appId** (string) - Required - Identifies the app.

### Response
#### Success Response (200)
- **keys** (Array of objects) - List of returned keys.

#### Response Example
{
  "keys": [
    {
      "id": "app_67a0e949f0305f4a391e9d97",
      "displayName": "My Test Key",
      "secret": "2vErhBhv81FZ5YXbC5XElVcnoNSqz0XjhqSYII4AOT3GCA5UojDCT07Z9NG_4PVzcxv-Zdd7IpeBL-RcXvfOyw"
    }
  ]
}
```

--------------------------------

### Initialize SDK on button tap

Source: https://docs.smooch.io/guide/native-android-sdk

Example of initializing the SDK and showing the conversation activity upon a user interaction.

```java
package your.package;

import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.view.View;
import android.widget.Button;

import io.smooch.core.InitializationStatus;
import io.smooch.core.Settings;
import io.smooch.core.Smooch;
import io.smooch.core.SmoochCallback;
import io.smooch.ui.ConversationActivity;

public class YourActivity extends AppCompatActivity implements View.OnClickListener {
    @Override
    protected void onCreate(final Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        Button showConversationActivityButton = findViewById(R.id.button_show_conversation_activity);
        showConversationActivityButton.setOnClickListener(this);
    }

    public void onClick(View v) {
        final int id = v.getId();

        if (id == R.id.button_show_conversation_activity) {
            Smooch.init(getApplication(), new Settings("YOUR_INTEGRATION_ID"), new SmoochCallback<InitializationStatus>() {
                @Override
                public void run(@NonNull Response<InitializationStatus> response) {
                    if (response.getData() == InitializationStatus.SUCCESS) {
                        ConversationActivity.show(getApplicationContext());
                    } else {
                        // Something went wrong during initialization
                    }
                }
            });

        }
    }
}
```

--------------------------------

### List Participants Request Path

Source: https://docs.smooch.io/rest?javascript=

Example path for listing participants with cursor pagination parameters.

```text
/v2/apps/:appId/conversations/:conversationId/participants?page[before]=26508c10541a4b0ff472e5e2
```

--------------------------------

### Install Smooch via NPM

Source: https://docs.smooch.io/guide/web-messenger

Run this command in your terminal to add the package to your project dependencies.

```bash
$ npm install smooch
```

--------------------------------

### Configure Business Profile with Smooch.init

Source: https://docs.smooch.io/guide/web-messenger

Sets the business name and icon URL for branding purposes.

```javascript
Smooch.init({
    integrationId: '<integration-id>',
    // ...
    businessName: 'Acme Corporation',
    businessIconUrl:
        'https://is2-ssl.mzstatic.com/image/thumb/Purple127/v4/67/a4/5b/67a45b68-c821-842f-22f5-9fa83b605ce3/mzl.evidoiah.jpg/1200x630bb.jpg'
    // ...
}).then(
    function () {
        // Your code after init is complete
    },
    function (err) {
        // Something went wrong during initialization
    }
);
```

--------------------------------

### Settings(String, String)

Source: https://docs.smooch.io/api/android/index-all.html

Initializes a Settings instance with the given app id, integration id and auth code flag.

```APIDOC
## Settings(String, String)

### Description
Initializes a `Settings` instance with the given app id, integration id and auth code flag.

### Parameters
- **appId** (String) - Required
- **integrationId** (String) - Required
```

--------------------------------

### +initWithSettings:completionHandler:

Source: https://docs.smooch.io/api/ios/Classes/Smooch.html

Initializes the Smooch SDK with the provided settings. This method should be called once, typically in the application delegate.

```APIDOC
## +initWithSettings:completionHandler:

### Description
Initializes the Smooch SDK with the provided settings. This method must be called only once, preferably in application:didFinishLaunchingWithOptions:.

### Parameters
- **settings** (SKTSettings) - Required - The settings to use.
- **handler** (void (^)(NSError *, NSDictionary *)) - Optional - An optional block to evaluate the result of the operation.
```

--------------------------------

### GET /v2/apps/{appId}/integrations/{integrationId}/keys/{keyId}

Source: https://docs.smooch.io/rest?javascript=

Get the specified API key.

```APIDOC
## GET /v2/apps/{appId}/integrations/{integrationId}/keys/{keyId}

### Description
Get the specified API key.

### Method
GET

### Endpoint
/v2/apps/{appId}/integrations/{integrationId}/keys/{keyId}

### Parameters
#### Path Parameters
- **appId** (string) - Required - Identifies the app.
- **integrationId** (string) - Required - The id of the integration.
- **keyId** (string) - Required - The id of the key.

### Response
#### Success Response (200)
- **key** (object) - The integration key.

#### Response Example
{
  "key": {
    "id": "int_67a1110ef0305f4a391e9f01",
    "displayName": "My Test Key",
    "secret": "JWSooRf7mjKYQereu5ueIjxKdclNs7cdCDaT7bGHEitHFUbNxFb8C0Cwi0s7SG0vhjMDef_w5d-TVetWHanIBA"
  }
}
```

--------------------------------

### Set Starting Text

Source: https://docs.smooch.io/api/android/io/smooch/ui/ConversationActivityBuilder.html

Specifies the text to pre-fill in the conversation activity input field.

```java
public ConversationActivityBuilder withStartingText(java.lang.String startingText)
```

--------------------------------

### Create Source Directory

Source: https://docs.smooch.io/guide/web-messenger

Create the source directory for project files.

```bash
$ mkdir src
```

--------------------------------

### Synchronize User Response Example

Source: https://docs.smooch.io/rest?javascript=

Successful response object containing the updated user details.

```json
{
  "user": {
    "id": "67a11490f0305f4a391e9f8a",
    "externalId": "your-own-id",
    "zendeskId": "35436",
    "signedUpAt": "2025-02-03T19:10:08.152Z",
    "hasPaymentInfo": false,
    "identities": [ ],
    "profile": {
      "locale": "en",
      "localeOrigin": "zendeskAccount"
},
    "metadata": { }
}
}
```

--------------------------------

### Update Switchboard Response Example

Source: https://docs.smooch.io/rest?javascript=

Example JSON response structure for a successful update of a switchboard record.

```json
{
  "switchboard": {
    "id": "5ef21b132f21af34f088530d",
    "enabled": false
  }
}
```

--------------------------------

### Settings(String integrationId, String authCode)

Source: https://docs.smooch.io/api/android/io/smooch/core/Settings.html

Initializes a Settings instance with the integration ID and an authentication code.

```APIDOC
### Constructor
`Settings(String integrationId, String authCode)`

Initializes a Settings instance with the given integration id and auth code.

#### Parameters
- **integrationId** (String) - Required - A valid integration id retrieved from the Smooch web portal.
- **authCode** (String) - Required - A valid auth code retrieved from the Smooch API to authenticate as an existing user.
```

--------------------------------

### Initialize Smooch SDK

Source: https://docs.smooch.io/api/ios/Classes/Smooch.html

Initializes the SDK with settings. This should be called once, typically in application:didFinishLaunchingWithOptions:.

```Objective-C
+ (void)initWithSettings:(nonnull SKTSettings *)settings
       completionHandler:(nullable void (^)(NSError *_Nullable,
                                            NSDictionary *_Nullable))handler;
```

```Swift
class func initWith(_ settings: SKTSettings) async throws -> [AnyHashable : Any]
```

--------------------------------

### GET /v2/apps/{appId}/users/{userIdOrExternalId}/devices

Source: https://docs.smooch.io/rest?javascript=

Get all the devices for a particular user. The Devices are sorted based on last seen time.

```APIDOC
## GET /v2/apps/{appId}/users/{userIdOrExternalId}/devices

### Description
Get all the devices for a particular user. The Devices are sorted based on last seen time.

### Method
GET

### Endpoint
/v2/apps/{appId}/users/{userIdOrExternalId}/devices

### Parameters
#### Path Parameters
- **appId** (string) - Required - Identifies the app.
- **userIdOrExternalId** (string) - Required - The user's id or externalId.

#### Query Parameters
- **brandId** (string) - Optional - Identifies the brand. Provide this when querying a brand-separated user by externalId or identity.

### Response
#### Success Response (200)
- **devices** (Array of objects) - List of returned devices.
```

--------------------------------

### List Clients Request Path

Source: https://docs.smooch.io/rest?javascript=

Example of the request path for listing clients, including a cursor pagination parameter.

```text
/v2/apps/:appId/users/:userId/clients?page[after]=5ebee0975ac5304b664a12fa
```

--------------------------------

### Webhook Event Payload Example

Source: https://docs.smooch.io/rest?javascript=

Example of a JSON payload received by a webhook, containing app information, webhook metadata, and a list of events.

```json
{
  "app": {
    "id": "60bf823452c2a718162f986a"
},
  "webhook": {
    "id": "612905a67821c3f206d6909f",
    "version": "v2"
},
  "events": [
    {
      "id": "61290a62c64b3af1ff868714",
      "createdAt": "2021-08-27T15:53:06.744Z",
      "type": "client:add",
      "payload": {
        "conversation": {
          "id": "c2c8710dedf8f26ee6e9a68f",
          "type": "personal"
},
        "user": {
          "id": "6a2343df57be6fe0f98efc33",
          "authenticated": false
},
        "client": {
          "integrationId": "60bfc8fa67951336472cc57a",
          "type": "twilio",
          "id": "61290a4f7821c3f206d690a3",
          "status": "pending"
},
        "reason": "channelLinking",
        "source": {
          "type": "web",
          "integrationId": "60bf824952c2a718162f989c"
}
}
}
]

}
```

--------------------------------

### Smooch.init(Application, Settings, SmoochCallback<InitializationStatus>)

Source: https://docs.smooch.io/api/android/index-all.html

Initializes the Smooch SDK with the provided settings and a callback to handle the initialization status.

```APIDOC
## Smooch.init(Application, Settings, SmoochCallback<InitializationStatus>)

### Description
Initializes the Smooch SDK with the provided settings. The callback provides the initialization status.

### Parameters
- **application** (Application) - The Android Application instance.
- **settings** (Settings) - The configuration settings for the SDK.
- **callback** (SmoochCallback<InitializationStatus>) - Callback to receive the initialization result.
```

--------------------------------

### GET /v2/apps/{appId}/integrations/{integrationId}/webhooks/{webhookId}

Source: https://docs.smooch.io/rest?javascript=

Gets the specified webhook associated with a Sunshine Conversations Connect integration or a custom integration.

```APIDOC
## GET /v2/apps/{appId}/integrations/{integrationId}/webhooks/{webhookId}

### Description
Gets the specified webhook associated with a Sunshine Conversations Connect integration or a custom integration.

### Method
GET

### Endpoint
/v2/apps/{appId}/integrations/{integrationId}/webhooks/{webhookId}

### Parameters
#### Path Parameters
- **appId** (string) - Required - Identifies the app.
- **integrationId** (string) - Required - The id of the integration.
- **webhookId** (string) - Required - The id of the webhook.

### Response
#### Success Response (200)
- **webhook** (object) - The webhook.

#### Response Example
{
  "webhook": {
    "id": "5e554d2cac66fb73a3c01871",
    "version": "v2",
    "target": "https://example.com/callback",
    "triggers": [
      "conversation:read",
      "conversation:message"
    ],
    "secret": "8564b3e6a8b20a4bdb68b05ce9bc5936",
    "includeFullUser": false,
    "includeFullSource": false
  }
}
```

--------------------------------

### Get App Response Sample

Source: https://docs.smooch.io/rest?javascript=

JSON response structure for a successful request to retrieve a single app.

```json
{
  "app": {
    "id": "67a0e55ef0305f4a391e9d69",
    "displayName": "My Test App",
    "settings": {
      "appLocalizationEnabled": true,
      "echoPostback": false,
      "maskCreditCardNumbers": true,
      "multiConvoEnabled": false,
      "useAnimalNames": false
    }
  }
}
```

--------------------------------

### List Devices Response Sample

Source: https://docs.smooch.io/rest?javascript=

A sample JSON response containing a list of devices for a specific user.

```json
{
  "devices": [
    {
      "id": "5d9b870dda96abc332625ccc",
      "guid": "f1c7abea2d49429db10094be820d5f80",
      "clientId": "5d9b870dda96abc332625cc8",
      "integrationId": "5d83a25d9916b64a83ed25e8",
      "type": "web",
      "status": "active",
      "info": {
        "currentTitle": "My Web Page",
        "currentUrl": "https://example.com",
        "browserLanguage": "en-US",
        "referrer": "https://example.com",
        "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/132.0.0.0 Safari/537.36",
        "URL": "example.com",
        "sdkVersion": "0.1",
        "vendor": "zendesk"
},
      "lastSeen": "2025-01-28T17:59:58.331Z"
}
]

}
```

--------------------------------

### Initialize SDK with Authentication Delegate (Objective-C)

Source: https://docs.smooch.io/guide/native-ios-sdk

Initialize the SDK with custom authentication settings. The authentication delegate handles invalid token errors by providing a new token.

```objective-c
SKTSettings *settings = [[SKTSettings alloc] init];
settings.authenticationDelegate = authDelegate;
[Smooch initWithSettings:settings completionHandler:completionHandlerBlock];
```

--------------------------------

### Smooch.getMessageModifierDelegate()

Source: https://docs.smooch.io/api/android/index-all.html

Gets the delegate set via Smooch.setMessageModifierDelegate.

```APIDOC
## static MessageModifierDelegate getMessageModifierDelegate()

### Description
Gets the delegate set via Smooch.setMessageModifierDelegate(MessageModifierDelegate).
```

--------------------------------

### GET /v2/apps/{appId}/integrations/{integrationId}/keys

Source: https://docs.smooch.io/rest?javascript=

Lists all API keys for a given integration.

```APIDOC
## GET /v2/apps/{appId}/integrations/{integrationId}/keys

### Description
Lists all API keys for a given integration.

### Method
GET

### Endpoint
/v2/apps/{appId}/integrations/{integrationId}/keys

### Parameters
#### Path Parameters
- **appId** (string) - Required - Identifies the app.
- **integrationId** (string) - Required - The id of the integration.

### Response
#### Success Response (200)
- **keys** (Array of objects) - Integration keys of the supplied integration.

#### Response Example
{
  "keys": [
    {
      "id": "int_67a1110ef0305f4a391e9f01",
      "displayName": "My Test Key",
      "secret": "JWSooRf7mjKYQereu5ueIjxKdclNs7cdCDaT7bGHEitHFUbNxFb8C0Cwi0s7SG0vhjMDef_w5d-TVetWHanIBA"
    }
  ]
}
```

--------------------------------

### +showWithStartingText:

Source: https://docs.smooch.io/api/ios/Classes/Smooch.html

Presents the conversation screen with prefilled text.

```APIDOC
## +showWithStartingText:

### Description
Presents the Smooch conversation screen with prefilled text in the message input.

### Parameters
- **startingText** (NSString) - Optional - The text to prefill in the message input.
```

--------------------------------

### Get Coordinates

Source: https://docs.smooch.io/api/android/io/smooch/core/Message.html

Retrieves the coordinates associated with the message.

```java
public Coordinates getCoordinates()
```

--------------------------------

### Get App Name

Source: https://docs.smooch.io/api/android/io/smooch/core/Config.html

Retrieves the name of the application.

```java
public java.lang.String getAppName()
```

--------------------------------

### Create App Key Response Sample

Source: https://docs.smooch.io/rest?javascript=

Example response body containing the created key's ID, display name, and secret.

```json
{
  "key": {
    "id": "app_67a0e949f0305f4a391e9d97",
    "displayName": "My Test Key",
    "secret": "2vErhBhv81FZ5YXbC5XElVcnoNSqz0XjhqSYII4AOT3GCA5UojDCT07Z9NG_4PVzcxv-Zdd7IpeBL-RcXvfOyw"
  }
}
```

--------------------------------

### Initialize Web Messenger with Custom Base URL

Source: https://docs.smooch.io/guide/web-messenger

Licensed Zendesk customers should use configBaseUrl to specify the configuration request endpoint.

```javascript
<script>
    Smooch.init({
        integrationId: '<integration-id>',
        configBaseUrl: 'https://<subdomain>.zendesk.com/sc/'
    }).then(
        function () {
            // Your code after init is complete
        },
        function (err) {
            // Something went wrong during initialization
        }
    );
</script>
```

--------------------------------

### Initialize Settings with Integration ID and Auth Code

Source: https://docs.smooch.io/api/android/io/smooch/core/Settings.html

Creates a new Settings instance using both an integration ID and an authentication code for existing user authentication.

```java
public Settings(java.lang.String integrationId,
                java.lang.String authCode)
```

--------------------------------

### onStartActivityCalled

Source: https://docs.smooch.io/api/android/io/smooch/core/ConversationViewDelegate.html

Notifies the delegate that a call to start an activity has been made.

```APIDOC
### void onStartActivityCalled(android.content.Intent intent)

Notifies the delegate that a call to start an activity has been made.

#### Parameters
- **intent** (android.content.Intent) - A copy of the description of the activity that will start.
```

--------------------------------

### Get Conversations

Source: https://docs.smooch.io/api/ios/Classes/Smooch.html

Retrieves a list of conversations from local storage.

```Objective-C
+ (void)getConversations:
    (nonnull void (^)(NSError *_Nullable, NSArray *_Nullable))completionHandler;
```

```Swift
class func conversations() async throws -> [Any]
```

--------------------------------

### Create Webhook Response Sample

Source: https://docs.smooch.io/rest?javascript=

Example JSON response returned upon successfully creating a webhook.

```json
{
  "webhook": {
    "id": "5e554d2cac66fb73a3c01871",
    "version": "v2",
    "target": "https://example.com/callback",
    "triggers": [
      "conversation:read",
      "conversation:message"
],
    "secret": "8564b3e6a8b20a4bdb68b05ce9bc5936",
    "includeFullUser": false,
    "includeFullSource": false
}

}
```

--------------------------------

### Get Message Entity

Source: https://docs.smooch.io/api/android/io/smooch/core/Message.html

Retrieves the underlying MessageDto entity.

```java
public MessageDto getEntity()
```

--------------------------------

### Initialize SDK with Authentication Delegate (Swift)

Source: https://docs.smooch.io/guide/native-ios-sdk

Initialize the SDK with custom authentication settings in Swift. The authentication delegate is responsible for refreshing authentication tokens.

```swift
let settings = SKTSettings(integrationId: "your_integration_id")
settings.authenticationDelegate = authDelegate
Smooch.initWith(settings)
```

--------------------------------

### Get Message File

Source: https://docs.smooch.io/api/android/io/smooch/core/Message.html

Retrieves the file associated with the message.

```java
public java.io.File getFile()
```

--------------------------------

### Get Message Image

Source: https://docs.smooch.io/api/android/io/smooch/core/Message.html

Retrieves the image associated with the message.

```java
public android.graphics.Bitmap getImage()
```

--------------------------------

### startTyping

Source: https://docs.smooch.io/api/android/io/smooch/core/Conversation.html

Notifies the server that the user is typing.

```APIDOC
## void startTyping()

### Description
Notify the server that the user is typing. This method is called automatically when using the default ConversationFragment; only call this method if your application implements its own conversation view.
```

--------------------------------

### Get Message ID

Source: https://docs.smooch.io/api/android/io/smooch/core/Message.html

Retrieves the unique identifier for the message.

```java
public java.lang.String getId()
```

--------------------------------

### List Integration Keys Response Sample

Source: https://docs.smooch.io/rest?javascript=

Example JSON response structure when listing all API keys for a specific integration.

```json
{
  "keys": [
    {
      "id": "int_67a1110ef0305f4a391e9f01",
      "displayName": "My Test Key",
      "secret": "JWSooRf7mjKYQereu5ueIjxKdclNs7cdCDaT7bGHEitHFUbNxFb8C0Cwi0s7SG0vhjMDef_w5d-TVetWHanIBA"
    }
  ]
}
```

--------------------------------

### Get Icon URL

Source: https://docs.smooch.io/api/android/io/smooch/core/Config.html

Retrieves the URL for the application icon.

```java
public java.lang.String getIconUrl()
```

--------------------------------

### SKTConversationActivityTypeTypingStart Declaration

Source: https://docs.smooch.io/api/ios/Constants.html

Activity type indicating a participant has started typing.

```Objective-C
extern NSString *const _Nonnull SKTConversationActivityTypeTypingStart
```

```Swift
let SKTConversationActivityTypeTypingStart: String
```

--------------------------------

### GET /v2/apps/{appId}

Source: https://docs.smooch.io/rest?javascript=

Fetches an individual app by its unique identifier.

```APIDOC
## GET /v2/apps/{appId}

### Description
Fetches an individual app.

### Method
GET

### Endpoint
/v2/apps/{appId}

### Parameters
#### Path Parameters
- **appId** (string) - Required - Identifies the app.

### Response
#### Success Response (200)
- **app** (object) - The app.

#### Response Example
{
  "app": {
    "id": "67a0e55ef0305f4a391e9d69",
    "displayName": "My Test App",
    "settings": {
      "appLocalizationEnabled": true,
      "echoPostback": false,
      "maskCreditCardNumbers": true,
      "multiConvoEnabled": false,
      "useAnimalNames": false
    }
  }
}
```

--------------------------------

### Initialize Settings with Integration ID

Source: https://docs.smooch.io/api/android/io/smooch/core/Settings.html

Creates a new Settings instance using a valid integration ID from the Smooch web portal.

```java
public Settings(java.lang.String integrationId)
```

--------------------------------

### Get Display Settings

Source: https://docs.smooch.io/api/android/io/smooch/core/Message.html

Retrieves the display settings for carousel messages.

```java
public DisplaySettings getDisplaySettings()
```

--------------------------------

### Access Media URL

Source: https://docs.smooch.io/api/ios/Classes/SKTMessage.html

Gets or sets the URL for media assets.

```Objective-C
@property (nullable) NSString *mediaUrl;
```

```Swift
var mediaUrl: String? { get set }
```

--------------------------------

### Get Message Modifier Delegate

Source: https://docs.smooch.io/api/android/io/smooch/core/Smooch.html

Retrieves the currently set MessageModifierDelegate.

```java
public static MessageModifierDelegate getMessageModifierDelegate()
```

--------------------------------

### Initialize Web Messenger with NPM

Source: https://docs.smooch.io/guide/web-messenger

Require the module and initialize it using your integration ID.

```javascript
var Smooch = require('smooch');

Smooch.init({ integrationId: '<integration-id>' }).then(
    function () {
        // Your code after init is complete
    },
    function (err) {
        // Something went wrong during initialization
    }
);
```

--------------------------------

### Get Conversation View Delegate

Source: https://docs.smooch.io/api/android/io/smooch/core/Smooch.html

Retrieves the currently set ConversationViewDelegate.

```java
public static ConversationViewDelegate getConversationViewDelegate()
```

--------------------------------

### Create Switchboard Integration Response Sample

Source: https://docs.smooch.io/rest?javascript=

Example JSON response body returned after successfully creating a switchboard integration.

```json
{
  "switchboardIntegration": {
    "id": "5ef21b86e933b7355c11c604",
    "name": "zd-agentWorkspace",
    "integrationId": "5ef21b86e933b7355c11c605",
    "integrationType": "zd:agentWorkspace",
    "deliverStandbyEvents": false
  }
}
```

--------------------------------

### Get current conversation

Source: https://docs.smooch.io/api/android/io/smooch/core/Smooch.html

Retrieves the conversation currently active in the session.

```java
public static Conversation getConversation()
```

--------------------------------

### Accessing unreadCount

Source: https://docs.smooch.io/api/ios/Classes/SKTParticipant.html

Gets or sets the number of unread messages for the participant.

```Objective-C
@property NSNumber *_Nonnull unreadCount;
```

```Swift
var unreadCount: NSNumber { get set }
```

--------------------------------

### Get User Metadata

Source: https://docs.smooch.io/api/android/io/smooch/core/User.html

Retrieves the custom metadata map for the user.

```java
public java.util.Map<java.lang.String,java.lang.Object> getMetadata()
```

--------------------------------

### Run Development Build

Source: https://docs.smooch.io/guide/web-messenger

Execute the webpack development build command.

```bash
$ npm run dev
```

--------------------------------

### Initialize Settings with Integration ID and Auth Code

Source: https://docs.smooch.io/api/ios/Classes/SKTSettings.html

Creates a settings object using both an integration ID and an authentication code.

```Objective-C
+ (nonnull instancetype)settingsWithIntegrationId:
                            (nonnull NSString *)integrationId
                                      andAuthCode:(nonnull NSString *)authCode;
```

```Swift
convenience init(integrationId: String, andAuthCode authCode: String)
```

--------------------------------

### Get User Email

Source: https://docs.smooch.io/api/android/io/smooch/core/User.html

Retrieves the user's email address.

```java
public java.lang.String getEmail()
```

--------------------------------

### Configure Xcode Runtime Search Paths

Source: https://docs.smooch.io/faq/ios

Ensure your project's `Runtime Search Paths` are correctly set to resolve framework loading issues in Xcode.

```bash
LD_RUNPATH_SEARCH_PATHS = "$(inherited), @executable_path/Frameworks"
```

--------------------------------

### Initialize SDK with Google Maps API Key

Source: https://docs.smooch.io/guide/native-android-sdk

Provide a Google Maps API key during initialization to enable location message previews.

```java
Settings settings = new Settings("YOUR_INTEGRATION_ID");
settings.setMapsApiKey("YOUR_MAPS_API_KEY");

Smooch.init(this, settings, new SmoochCallback<InitializationStatus>() {
    @Override
    public void run(@NonNull Response<InitializationStatus> response) {
        if (response.getData() == InitializationStatus.SUCCESS) {
            // Your code after init is complete
        } else {
            // Something went wrong during initialization
        }
    }
});
```

--------------------------------

### String Representation

Source: https://docs.smooch.io/api/android/io/smooch/core/SmoochCallback.Response.html

Method to get the string representation of the response object.

```java
public java.lang.String toString()
```

--------------------------------

### Configure Background Image with Smooch.init

Source: https://docs.smooch.io/guide/web-messenger

Sets a custom background image for the conversation area, which is tiled if necessary.

```css
 {
    background-image: url('https://a-nice-texture.png');
}
```

```javascript
Smooch.init({
    integrationId: '<integration-id>',
    // ...
    backgroundImageUrl: 'https://a-nice-texture.png'
    // ...
}).then(
    function () {
        // Your code after init is complete
    },
    function (err) {
        // Something went wrong during initialization
    }
);
```

--------------------------------

### Get Unread Count

Source: https://docs.smooch.io/api/android/io/smooch/core/Participant.html

Retrieves the number of unread messages for the participant.

```java
public int getUnreadCount()
```

--------------------------------

### Get Longitude Method

Source: https://docs.smooch.io/api/android/io/smooch/core/Coordinates.html

Retrieves the longitude value from the Coordinates object.

```java
public java.lang.Double getLong()
```

--------------------------------

### Get Latitude Method

Source: https://docs.smooch.io/api/android/io/smooch/core/Coordinates.html

Retrieves the latitude value from the Coordinates object.

```java
public java.lang.Double getLat()
```

--------------------------------

### Get Participant Name

Source: https://docs.smooch.io/api/android/io/smooch/core/ConversationEvent.html

Retrieves the name of the participant related to the event.

```java
public java.lang.String getName()
```

--------------------------------

### Get Participant Role

Source: https://docs.smooch.io/api/android/io/smooch/core/ConversationEvent.html

Retrieves the role of the participant, such as 'appUser' or 'business'.

```java
public java.lang.String getRole()
```

--------------------------------

### Smooch.init

Source: https://docs.smooch.io/javascript

Initializes the Web Messenger with specific configuration options for branding and UI behavior.

```APIDOC
## Smooch.init

### Description
Initializes the Smooch Web Messenger with custom settings for display, branding, and appearance.

### Parameters
- **integrationId** (string) - Required - The unique identifier for your integration.
- **displayStyle** (string) - Optional - Sets the display mode to 'button' or 'tab'.
- **buttonIconUrl** (string) - Optional - URL for the custom button icon (min 200x200px, JPG/PNG/GIF).
- **buttonWidth** (string) - Optional - Custom width for the button.
- **buttonHeight** (string) - Optional - Custom height for the button.
- **fixedHeader** (boolean) - Optional - If true, pins the header at the top of the conversation.
- **customColors** (object) - Optional - Object containing brandColor, conversationColor, and actionColor.
- **businessName** (string) - Optional - The name displayed for the business.
- **businessIconUrl** (string) - Optional - URL for the business icon (min 200x200px, JPG/PNG/GIF).
- **backgroundImageUrl** (string) - Optional - URL for the conversation background image.
```

--------------------------------

### Get Event Type

Source: https://docs.smooch.io/api/android/io/smooch/core/ConversationEvent.html

Retrieves the specific type of the triggered event.

```java
public ConversationEventType getType()
```

--------------------------------

### Create an App with a Service Account Key

Source: https://docs.smooch.io/guide/using-service-accounts

Use a service account API key to create a new app. The service account is automatically granted access to the apps it creates.

```bash
curl https://api.smooch.io/v1.1/apps \
  -X POST \
  -d '{"name": "My App"}' \
  --user 'keyId:keySecret'
```

--------------------------------

### Manage Conversations

Source: https://docs.smooch.io/api/android/io/smooch/core/Smooch.html

Methods for starting or creating conversations. Note that startConversation is deprecated.

```java
@Deprecated
public static void startConversation(SmoochCallback<java.lang.Void> callback)
```

```java
public static void createConversation(java.lang.String name,
                                      java.lang.String description,
                                      java.lang.String iconUrl,
                                      java.lang.String avatarUrl,
                                      java.util.List<Message> messages,
                                      java.util.Map<java.lang.String,java.lang.Object> metadata,
                                      SmoochCallback<java.lang.Void> callback)
```

--------------------------------

### List App Keys Response Sample

Source: https://docs.smooch.io/rest?javascript=

Sample JSON response for the List App Keys endpoint.

```json
{
  "keys": [
    {
      "id": "app_67a0e949f0305f4a391e9d97",
      "displayName": "My Test Key",
      "secret": "2vErhBhv81FZ5YXbC5XElVcnoNSqz0XjhqSYII4AOT3GCA5UojDCT07Z9NG_4PVzcxv-Zdd7IpeBL-RcXvfOyw"
    }
  ]
}
```

--------------------------------

### onCreate Method

Source: https://docs.smooch.io/api/android/io/smooch/features/conversationlist/ConversationListActivity.html

Standard Android activity lifecycle method for initialization.

```java
protected void onCreate(android.os.Bundle savedInstanceState)
```

--------------------------------

### GET /v2/apps/{appId}/switchboards

Source: https://docs.smooch.io/rest?javascript=

Lists all switchboards belonging to the specified app.

```APIDOC
## GET /v2/apps/{appId}/switchboards

### Description
Lists all switchboards belonging to the app.

### Method
GET

### Endpoint
/v2/apps/{appId}/switchboards

### Parameters
#### Path Parameters
- **appId** (string) - Required - Identifies the app.

### Response
#### Success Response (200)
- **switchboards** (Array of objects) - List of returned switchboards.

#### Response Example
{
  "switchboards": [
    {
      "id": "5ef21b132f21af34f088530d",
      "enabled": false
    }
  ]
}
```

--------------------------------

### Configure Display Style with Smooch.init

Source: https://docs.smooch.io/guide/web-messenger

Sets the messenger display mode and custom button icon URL during initialization.

```javascript
Smooch.init({
    integrationId: '<integration-id>',
    // ...
    displayStyle: 'button',
    buttonIconUrl: 'https://myimage.png'
    // ...
}).then(
    function () {
        // Your code after init is complete
    },
    function (err) {
        // Something went wrong during initialization
    }
);
```

--------------------------------

### List Integrations Request Path

Source: https://docs.smooch.io/rest?javascript=

Example request path for listing integrations with cursor pagination and type filtering.

```text
/v2/apps/:appId/integrations?page[after]=5e1606762556d93e9c176f69&page[size]=10&filter[types]=custom,web
```
Tokens:
Raw