com.sinch.sdk.domains.sms.models.webhooks.package-info 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

/**
 * SMS API webhooks related models
 *
 * Incoming SMS WebHook
 *
 * An inbound message is a message sent to one of your short codes or long numbers from a mobile
 * phone. To receive inbound message callbacks, a URL needs to be added to your REST API.
 *
 * 
This URL can be specified in your Dashboard.
 *
 * 
See https://developers.sinch.com/docs/sms/api-reference/sms/tag/Webhooks/#tag/Webhooks/operation/incomingSMS
 *
 * 
Delivery Report WebHook
 *
 * A delivery report contains the status and status code for each recipient of a batch. To get a
 * delivery report callback for a message or batch of messages, set the delivery_report
 *  field accordingly when creating a batch.
 *
 * 
The following is provided so you can better understand our webhooks/callbacks. Configuration
 * of both webhooks and the type of delivery report requested happens when sending a batch.
 *
 * 
Callback URL
 *
 * 
The callback URL can either be provided for each batch or provisioned globally for your
 * account in your Sinch Customer Dashboard.
 * Learn how to configure a webhook/callback here
 *
 * 
Type
 *
 * 
The type is the type of delivery report webhook. The response will vary depending
 * on the webhook delivery report you selected when the batch was sent, so choose the appropriate
 * selection under "One of".
 *
 * 

 *   The delivery_report_sms and delivery_report_mms types are
 *       documented under Delivery report.
 *       These are reports containing either
 *       a full report or summary report, depending on your selection at the time the batch was
 *       sent.
 *   
The recipient_delivery_report_sms and recipient_delivery_report_mms
 *        delivery report types are documented under Recipient delivery report.
 *       These are delivery reports for recipient phone numbers. If you set per_recipient
 *        for the delivery_report parameter when sending the batch, a recipient
 *       report gets sent to you for each status change for each recipient in your batch. If you set
 *       per_recipient_final, a recipient report gets sent to you for the final status
 *       of each recipient in your batch.
 * 
 *
 * See https://developers.sinch.com/docs/sms/api-reference/sms/tag/Webhooks/#tag/Webhooks/operation/deliveryReport
 *
 * @since 1.0
 */
package com.sinch.sdk.domains.sms.models.webhooks;