End Status Notification from the Dimension of Phone Call

POST

The party provides this url to configure in the workflow

When the phone call of the task ends (the number of calls completed or connected), regardless of whether the call is connected or not, the party will be actively notified of the dialing data of the task. If this url responds abnormally, we will retry at 1 minute intervals, and no further notification will be made after a maximum of 5 failed retries.

请求参数

Header 参数

Content-Type

string

必需

默认值:

application/json

User-Agent

string

可选

默认值:

Airudder

Body 参数application/json

workflow_id

string

必需

workflow task uniquely id

workflow_name

string

必需

nodetask_id

string

必需

workflow node details ID, no need to follow

nodetask_name

string

必需

TaskID

string

必需

Once a task is added successfully, you will get the Task ID, or from th list API.

TaskName

string

Task Name

必需

Sign

string

必需

md5 signature value, the party can verify the signature and then perform subsequent processing on the task ID. You can also do no verification.
Signature rule: The hexadecimal lowercase value of the utf-8 encoded md5 calculation result of TaskID+KEY. For example TaskID=ac23fa05005e59b92e0b8a19fa5faf07
KEY=airudder
Calculation formula= md5(TaskID+KEY).hexdigest()
md5 value = 4d6017151d678e816c678d90e56e6e28

Details

array [object {22}]

必需

Time returned is in UTC +00:00 time zone.

integer

必需

Phone details ID, no need to follow

RobotID

string

必需

The RobotID of the robot use in the call

CalleeName

string

必需

CalleeGender

enum<string>

必需

枚举值:

malefemale

CalleeNumber

string

必需

CallStartTime

string

必需

Time returned is in UTC +00:00 time zone.

CallEndTime

string

必需

Time returned is in UTC +00:00 time zone.

Status

enum<string>

必需

枚举值:

createdpendingfinishedcancelledfailed

Intention

enum<string>

必需

Call label, each robot has a different label, please log in to the iCALL web-robot list page to view

枚举值:

ABCDEFGHI……--

CallID

string

必需

A unique ID for each call

CallTimes

integer

必需

Calling times until reached the end user

PlatformName

string

可选

RingType

enum<string>

必需

枚举值:

busycantuseholdlineswitchoffoutofareaunregisterwrongnumnotmatchnormalnull

HangupType

enum<string>

必需

Robot or Callee hangs up a phonecall

枚举值:

ByCalleeByRobotCanceled

ExtraA

string

可选

ExtraB

string

可选

ExtraC

string

可选

Slots

string

可选

AsrResult

array[string]

可选

AsrPTP

string

可选

Multi_intention

string

可选

CaseID

string | null

必需

The unique number of the customer, the default is the same as callee.

示例

{
  "workflow_id": "439cef2fefe04fe4b8747ea100001",
  "workflow_name": "86_202210290000",
  "nodetask_id": "94d5f27dd2f34c63867ec5abfe000000",
  "nodetask_name": "Outbound Call43_5c0645",
  "TaskID": "3734137d13042f318069b22222c000000",
  "TaskName": "wf_86_202210290730_Outbound Call43_f000000",
  "Sign": "247ffc59ea7cfd745bc9fb0000000000",
  "Details": [
    {
      "id": 831507394,
      "RobotID": "1234",
      "CalleeName": "finished",
      "CalleeGender": "male",
      "CalleeNumber": "+6212345678",
      "CallStartTime": "2022-11-01T11:30:26Z",
      "CallEndTime": "2022-11-01T11:30:26Z",
      "Status": "failed",
      "Intention": "A",
      "CallID": "cd0edf068331fb0f590d00000000",
      "CallTimes": 4,
      "Comments": "",
      "customer_name": "test-user1",
      "gender": "male",
      "location": "Silicon Valley",
      "PlatformName": "PlatformName",
      "RingType": "outofarea",
      "HangupType": "ByCallee",
      "ExtraA": "",
      "ExtraB": "",
      "ExtraC": "2022-10-28",
      "Slots": "",
      "AsrResult": [
        {
          "time": "00:00:00",
          "robottext": "selamat sore",
          "text": "halo halo"
        },
        {
          "time": "00:00:09",
          "robottext": "Saya Daniel ",
          "text": "halo halo halo halo"
        }
      ],
      "AsrPTP": "",
      "Multi_intention": "{}",
      "CaseID": "2_22102740014491234"
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'The party provides this url to configure in the workflow' \
--header 'User-Agent: Airudder' \
--header 'Content-Type: application/json' \
--data-raw '{
  "workflow_id": "439cef2fefe04fe4b8747ea100001",
  "workflow_name": "86_202210290000",
  "nodetask_id": "94d5f27dd2f34c63867ec5abfe000000",
  "nodetask_name": "Outbound Call43_5c0645",
  "TaskID": "3734137d13042f318069b22222c000000",
  "TaskName": "wf_86_202210290730_Outbound Call43_f000000",
  "Sign": "247ffc59ea7cfd745bc9fb0000000000",
  "Details": [
    {
      "id": 831507394,
      "RobotID": "1234",
      "CalleeName": "finished",
      "CalleeGender": "male",
      "CalleeNumber": "+6212345678",
      "CallStartTime": "2022-11-01T11:30:26Z",
      "CallEndTime": "2022-11-01T11:30:26Z",
      "Status": "failed",
      "Intention": "A",
      "CallID": "cd0edf068331fb0f590d00000000",
      "CallTimes": 4,
      "Comments": "",
      "customer_name": "test-user1",  
      "gender": "male",
      "location": "Silicon Valley",
      "PlatformName": "PlatformName",
      "RingType": "outofarea",
      "HangupType": "ByCallee",
      "ExtraA": "",
      "ExtraB": "",
      "ExtraC": "2022-10-28",
      "Slots": "",
      "AsrResult": [
        {
          "time": "00:00:00",
          "robottext": "selamat sore",
          "text": "halo halo"
        },
        {
          "time": "00:00:09",
          "robottext": "Saya Daniel ",
          "text": "halo halo halo halo"
        }
      ],
      "AsrPTP": "",
      "Multi_intention": "{}",
      "CaseID": "2_22102740014491234"
    }
  ]
}'

返回响应

🟢200success

application/json

Body

object {0}

示例

{}

Cancel a Call

Stop the Workflow Task