Sinch Node.js SDK - v1.5.0
    Preparing search index...

    Class BatchesApi

    Index

    Methods

    • Cancel a batch message A batch can be canceled at any point. If a batch is canceled while it's currently being delivered some messages currently being processed might still be delivered. The delivery report will indicate which messages were canceled and which weren't. Canceling a batch scheduled in the future will result in an empty delivery report while canceling an already sent batch would result in no change to the completed delivery report.

      Parameters

      Returns Promise<SendSMSResponse>

    • Dry run This operation will perform a dry run of a batch which calculates the bodies and number of parts for all messages in the batch without actually sending any messages.

      Parameters

      Returns Promise<DryRunResponse>

    • Send Text Message Send a text message or a batch of text messages. Depending on the length of the body, one message might be split into multiple parts and charged accordingly. Any groups targeted in a scheduled batch will be evaluated at the time of sending. If a group is deleted between batch creation and scheduled date, it will be considered empty. Be sure to use the correct region in the server URL.

      Parameters

      Returns Promise<SendSMSResponse>

    • Send Binary Message Send a binary message or a batch of binary messages. Depending on the length of the body, one message might be split into multiple parts and charged accordingly. Any groups targeted in a scheduled batch will be evaluated at the time of sending. If a group is deleted between batch creation and scheduled date, it will be considered empty. Be sure to use the correct region in the server URL.

      Parameters

      Returns Promise<BinaryResponse>

    • Send delivery feedback for a message Send feedback if your system can confirm successful message delivery. Feedback can only be provided if 'feedback_enabled' was set when batch was submitted. Batches: It is possible to submit feedback multiple times for the same batch for different recipients. Feedback without specified recipients is treated as successful message delivery to all recipients referenced in the batch. Note that the 'recipients' key is still required even if the value is empty. Groups: If the batch message was creating using a group ID, at least one recipient is required. Excluding recipients (an empty recipient list) does not work and will result in a failed request.

      Parameters

      Returns Promise<void>

    • Send Media Message Send a media message or a batch of media messages. Depending on the length of the body, one message might be split into multiple parts and charged accordingly. Any groups targeted in a scheduled batch will be evaluated at the time of sending. If a group is deleted between batch creation and scheduled date, it will be considered empty. Be sure to use the correct region in the server URL.

      Parameters

      Returns Promise<MediaResponse>

    • Send Text Message Send a text message or a batch of text messages. Depending on the length of the body, one message might be split into multiple parts and charged accordingly. Any groups targeted in a scheduled batch will be evaluated at the time of sending. If a group is deleted between batch creation and scheduled date, it will be considered empty. Be sure to use the correct region in the server URL.

      Parameters

      Returns Promise<TextResponse>