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

Interface AppsService

public interface AppsService
Apps Service

  • Method Details

    • list

      AppsListResponse list() throws ApiException
      List all apps for a given project

      Get a list of all apps in the specified project.

      Returns:
      AppsListResponse
      Throws:
      ApiException - if fails to make API call

    • create

      AppResponse create(AppCreateRequest appCreateRequest) throws ApiException
      Create an app

      You can create a new Conversation API app using the API. You can create an app for one or more channels at once. The ID of the app is generated at creation and will be returned in the response.

      Parameters:
      appCreateRequest - The app to create. (required)
      Returns:
      AppResponse
      Throws:
      ApiException - if fails to make API call

    • delete

      void delete(String appId) throws ApiException
      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 unique ID of the app. You can find this on the [Sinch Dashboard](https://dashboard.sinch.com/convapi/apps). (required)
      Throws:
      ApiException - if fails to make API call

    • get

      AppResponse get(String appId) throws ApiException
      Get an app

      Returns a particular app as specified by the App ID.

      Parameters:
      appId - The unique ID of the app. You can find this on the [Sinch Dashboard](https://dashboard.sinch.com/convapi/apps). (required)
      Returns:
      AppResponse
      Throws:
      ApiException - if fails to make API call

    • update

      AppResponse update(String appId, AppUpdateRequest appUpdateRequest) throws ApiException
      Update an app

      Updates a particular app as specified by the App ID. Note that this is a `PATCH` operation, so 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](https://developers.sinch.com/docs/conversation/api-reference/conversation/tag/App/#tag/App/operation/App_GetApp) 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. You can find this on the [Sinch Dashboard](https://dashboard.sinch.com/convapi/apps). (required)
      appUpdateRequest - The updated app. (required)
      Returns:
      AppResponse
      Throws:
      ApiException - if fails to make API call