com.sinch.sdk.domains.conversation.api.v1.CapabilityService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sinch-sdk-java Show documentation

SDK providing a Java API for the Sinch REST APIs.

There is a newer version: 1.4.0

package com.sinch.sdk.domains.conversation.api.v1;

import com.sinch.sdk.domains.conversation.models.v1.capability.request.QueryCapabilityRequest;
import com.sinch.sdk.domains.conversation.models.v1.capability.response.QueryCapabilityResponse;

/**
 * Service for working with capability
 *
 * A capability query checks the options available for reaching the contact on the channels on
 * which it has a channel identity.
 *
 * 
Capability queries can only be executed for contacts that already exist in a project and app.
 * For executing the request, either the contact ID or the channel recipient identities of the
 * contact are required.
 *
 * 
The request is executed asynchronously, therefore the service responds immediately. The result
 * of the capability query is sent to the registered webhook for the CAPABILITY trigger.
 *
 * @see online
 *     documentation
 * @since 1.3
 */
public interface CapabilityService {

  /**
   * Capability lookup
   *
   * 
This method is asynchronous - it immediately returns the requested Capability registration.
   *
   * Capability check is then delivered as a callback to registered webhooks with trigger 
   * CAPABILITY for every reachable channel.
   *
   * @param request The request parameters to lookup capability
   * @return The capability response
   * @since 1.3
   */
  QueryCapabilityResponse lookup(QueryCapabilityRequest request);
}