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

Interface ConsentsService

public interface ConsentsService
Consents Service

  • Method Details

    • listAuditRecords

      AuditRecordsResponse listAuditRecords(String appId, String identity) throws ApiException
      Get audit records from consent lists

      Get all audit records associated with the given identity from the consent lists within the specified project and app.

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

    • listIdentities

      ConsentsListResponse listIdentities(String appId, ConsentsListType listType) throws ApiException
      Get identities from consent list (using default parameters)

      Get all identities contained within a consent list for a given project id, app id, and list type.

      Parameters:
      appId - The unique ID of the app. You can find this on the [Sinch Dashboard](https://dashboard.sinch.com/convapi/apps). (required)
      listType - The consent list type. One of `OPT_OUT_ALL`, `OPT_OUT_MARKETING`, and or `OPT_OUT_NOTIFICATION`. (required)
      Returns:
      ConsentsListResponse
      Throws:
      ApiException - if fails to make API call

    • listIdentities

      ConsentsListResponse listIdentities(String appId, ConsentsListType listType, ConsentsListQueryParameters queryParameter) throws ApiException
      Get identities from consent list

      Get all identities contained within a consent list for a given project id, app id, and list type.

      Parameters:
      appId - The unique ID of the app. You can find this on the [Sinch Dashboard](https://dashboard.sinch.com/convapi/apps). (required)
      listType - The consent list type. One of `OPT_OUT_ALL`, `OPT_OUT_MARKETING`, and or `OPT_OUT_NOTIFICATION`. (required)
      queryParameter - (optional)
      Returns:
      ConsentsListResponse
      Throws:
      ApiException - if fails to make API call