PollBuildInProgress

POST

https://api.cbf.tcn.com/api/v1alpha1/wfm/pollbuildinprogress

Polls the scheduler to check if there is currently a build in progress for the given @draft_schedule_sid.
If there is a build in progress @build_in_progress will be true.
As long as there has been a build started for the given @draft_schedule_sid, @build_start_datetime will be set with the time that the build process started.
If a build has been completed for the draft, @build_end_datetime will be set with the time that the build ended, otherwise it will be None.
The @build_status gives the status of the most recent build for the draft.
The @diagnostics will be set with any diagnostics encountered during the most recent build.
Any errors encountered during the build process will be returned as INTERNAL_ERROR diagnostics.
Errors:

grpc.Invalid: the @draft_schedule_sid is invalid.

grpc.NotFound: the @draft_schedule_sid does not exist for the org sending the request.

grpc.Internal: error chceking for the build in progress.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "draft_schedule_sid": 0
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/wfm/pollbuildinprogress' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "draft_schedule_sid": 0
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "build_start_datetime": "1s",
    "build_in_progress": true,
    "build_end_datetime": "1s",
    "build_status": "NO_BUILD",
    "diagnostics": [
        {
            "level": "INFORMATION",
            "code": "GENERAL",
            "message": "string",
            "source_entity": {
                "parent_sid": 0,
                "parent_type": "CALL_CENTER_NODE"
            }
        }
    ]
}

🟢200Success

Modified at 2025-09-26 15:44:58

BuildDraftSchedule

CancelBuildInProgress