Cancel the processes for a specific list

Production

https://api.airudder.com

POST

/service/cloud/workflow/cancelphonecall

This interface is suitable for situations where there are changes to the information of lists during the workflow execution, and there is no need for further calling/reaching processes. By using this interface, you can cancel all subsequent processes for that particular list. When canceling a list, please consider the status of the workflow task. If it has already ended or been canceled, it will not be possible to cancel the list. Additionally, if all the processes within the workflow for that list have already been completed, it will also not be possible to cancel it.

Request

Header Params

Authorization

string

required

Default:

Token 3Ksb9EkFDQHBhAbvYDTq4+pGGjNRAuLtPF9MMt9E97hX+OgLWTmeZtdGZyjR+YqU

Content-Type

string

required

Default:

application/json

User-Agent

string

optional

Default:

Airudder

Body Params application/json

workflow_id

string

required

The workflow_id returned when the workflow was created.

caseid

string

optional

The unique identifier of the list, if available in the list information, can be used as an input parameter. Note: 1. Either the "callee" or "caseid" field can be used as optional parameters. 2. It is recommended to use "caseid" for cancellation.

callee

string

optional

Phone number of the list.

Example

{
    "workflow_id": "441523302d2f44f7b3fe000000",
    "caseid":"test-caseid-1",
    "callee": "+8612345678"
    
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.airudder.com/service/cloud/workflow/cancelphonecall' \
--header 'Authorization;' \
--header 'User-Agent: Airudder' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workflow_id": "441523302d2f44f7b3fe000000",
    "caseid":"test-caseid-1",
    "callee": "+8612345678"
    
}'

Responses

🟢200success

application/json

Body

data

object

required

caseid

string | null

required

count

integer

required

status

string

required

code

integer

required

Examples

successThe callee is not found in the Workflow or has already been canceled.The caseid is not found in the Workflow or has already been canceled.WorkFlow not exists

{
    "data": {
        "caseid": "test-caseid11",
        "count": 1
    },
    "status": "OK",
    "code": 200
}

🟢200Error

Modified at 2024-05-27 10:57:57

Update the List Info of Workflow Task

Notification of Call Completion in Workflow (Debt Collection/Marketing/E-commerce)