Package com.sinch.sdk.domains.conversation.api.v1

Interface AppService

public interface AppService
Applications related service

Apps are created and configured through the Sinch Dashboard, are tied to the API user and come with a set of channel credentials for each underlying connected channel.

The app has a list of conversations between itself and different contacts which share the same project.

Webhooks, which the app is attached to, defines the destination for various events coming from the Conversation API. An app has the following configurable properties:

Since:
1.3
See Also:

  • Method Details

    • list

      Collection<AppResponse> list()
      List all apps

      Get a list of all apps in the specified project

      Returns:
      List of apps related to configured region (from Configuration.Builder.setConversationRegion(ConversationRegion))
      Since:
      1.3

    • get

      AppResponse get(String appId)
      Get an app

      Returns a particular app as specified by the App ID.

      Parameters:
      appId - The application identifier
      Returns:
      App information details
      Since:
      1.3

    • delete

      void delete(String appId)
      Delete an app

      Deletes the app specified by the App ID

      Note that this operation will not delete contacts (which are stored at the project level) nor any channel-specific resources (for example, WhatsApp Sender Identities will not be deleted).

      Parameters:
      appId - The application identifier
      Since:
      1.3

    • create

      AppResponse create(AppCreateRequest parameters)
      Create a Conversation application

      You can create a new Conversation API app using the API.

      You can create an app for one or more channels at once.

      Parameters:
      parameters - Creation parameters
      Returns:
      Created application
      Since:
      1.3

    • update

      AppResponse update(String appId, AppUpdateRequest parameters)
      Update a Conversation application

      Updates a particular app as specified by the App ID.

      Any specified field values will replace existing values.

      Therefore, if you'd like to add additional configurations to an existing Conversation API app, ensure that you include existing values AND new values in the call.
      For example, if you'd like to add new channel_credentials, you can get your existing Conversation API app, extract the existing channel_credentials list, append your new configuration to that list, and include the updated channel_credentials list in this update call.

      Parameters:
      appId - The unique ID of the app to be updated
      parameters - Fields to be updated. Only fields filled within the parameters will be updated
      Returns:
      Updated application
      Since:
      1.3