Actions30
- Call Actions
- Contact Actions
- Dialer Actions
- Integration Actions
- List Actions
- Report Actions
- SMS Actions
- User Actions
- Developer Feedback Actions
Overview
This node operation allows users to cancel an existing dialer task in the Oki-Toki system. It is useful in scenarios where a scheduled or ongoing dialing task needs to be stopped or removed based on various criteria such as task ID, phone number, contact ID, or additional task details. For example, a user can cancel a specific task by its ID or cancel tasks associated with a particular phone number or CRM contact information.
Use Case Examples
- Cancel a dialer task by specifying its task ID to stop all associated calls.
- Cancel tasks that include a specific phone number or contact ID to prevent calls to that contact.
- Cancel tasks with additional JSON details matching certain criteria, providing fine-grained control over task cancellation.
Properties
| Name | Meaning |
|---|---|
| Dialer | Select the dialer to use for the cancellation operation. |
| Task ID | The ID of the task to cancel. Optional if other filters are used to identify tasks. |
| Phone | Phone number included in the task to be canceled. |
| Contact ID | Contact number from CRM to filter tasks for cancellation. |
| BP ID | Process number from CRM to filter tasks for cancellation. |
| Details | JSON string with additional information to match tasks for cancellation. |
| Cancel Phone | Boolean flag indicating whether to cancel only the specified phone number within the task. |
| Cancel Reason | Reason for cancellation to document why the task was canceled. |
Output
JSON
json- The JSON response from the Oki-Toki API indicating the result of the cancel task operation.
Dependencies
- Requires an API key credential for the Oki-Toki API to authenticate requests.
Troubleshooting
- Ensure the dialer ID is correctly selected and valid, as the operation requires a valid dialer context.
- If using task ID, verify that the task exists and belongs to the selected dialer.
- When filtering by phone, contact ID, or details, ensure the data matches exactly the task attributes to avoid no tasks being canceled.
- The API request uses HTTP GET with a request body for cancellation, which might cause issues with some HTTP clients; verify that the node environment supports this.
- Common error messages may include authentication failures (check API key), invalid parameters (check task ID and filters), or network errors (check connectivity).