EightByEight (8x8) icon

EightByEight (8x8)

8x8 API operations

Overview

This node interacts with the 8x8 API to perform operations related to SMS messaging, specifically including the cancellation of a batch of scheduled SMS messages. It is useful for managing SMS communications, such as sending individual or batch SMS messages and canceling scheduled SMS batches. For example, a user can cancel a batch of SMS messages that were scheduled to be sent later by providing the batch ID and sub-account ID.

Use Case Examples

  1. Cancel a batch of scheduled SMS messages by specifying the sub-account ID and batch ID to stop the messages from being sent.
  2. Send a batch of SMS messages to multiple recipients with optional templates and message content.

Properties

Name Meaning
Sub-Account ID ID of the sub-account used to identify the account context for the SMS operation.
Batch ID Identifier of the batch of scheduled SMS messages to be canceled.

Output

JSON

  • json - The JSON response from the 8x8 API, which may include details of the canceled batch or error information.

Dependencies

  • 8x8 API authentication credentials

Troubleshooting

  • Ensure that the Sub-Account ID and Batch ID are correctly provided and valid; otherwise, the API call to cancel the batch will fail.
  • If the operation is not supported or under development, an error will be thrown indicating the operation is not available.
  • Network or authentication errors may occur if the API credentials are incorrect or expired; verify the API key or token used for authentication.

Links

  • 8x8 SMS API Documentation - Official documentation for the 8x8 SMS API, including details on sending and canceling SMS batches.

Discussion