Package com.sinch.sdk.domains.sms

Interface WebHooksService

public interface WebHooksService
WebHooks

Callbacks

A callback is an HTTP POST request with a notification made by the Sinch SMS REST API to a URI of your choosing.

The REST API expects the receiving server to respond with a response code within the 2xx success range. For 5xx the callback will be retried. For 429 the callback will be retried and the throughput will be lowered. For other status codes in the 4xx range the callback will not be retried. The first initial retry will happen 5 seconds after the first try. The next attempt is after 10 seconds, then after 20 seconds, after 40 seconds, after 80 seconds, doubling on every attempt. The last retry will be at 81920 seconds (or 22 hours 45 minutes) after the initial failed attempt.

The SMS REST API offers the following callback options which can be configured for your account upon request to your account manager.

  • Callback with mutual authentication over TLS (HTTPS) connection by provisioning the callback URL with client keystore and password.
  • Callback with basic authentication by provisioning the callback URL with username and password.
  • Callback with OAuth 2.0 by provisioning the callback URL with username, password and the URL to fetch OAuth access token.
  • Callback using AWS SNS by provisioning the callback URL with an Access Key ID, Secret Key and Region.
Since:
1.0
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    WebhooksEvent
    parse(String jsonPayload)
    Parse and un-serialize incoming webhooks payload