TCN API

PlacePreviewDialCall

POST

https://api.cbf.tcn.com/api/v1alpha1/p3api/placepreviewdialcall

P3Api

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

call

object (SimpleCallData)

call

optional

result

enum<string>

result

optional

Allowed values:

CALL_RESULT_UNKNOWNCALL_RESULT_PENDINGCALL_RESULT_ANSWEREDCALL_RESULT_ANSWERED_LINKCALLCALL_RESULT_ANSWERED_LINKCALL_ABANDONEDCALL_RESULT_ANSWERED_LINKCALL_AGENT_TALKCALL_RESULT_ANSWERED_LINKCALL_SUSPENDEDCALL_RESULT_ANSWERED_LINKCALL_SUSPENDED_TIMEOUTCALL_RESULT_ANSWERED_LINKCALL_SUSPENDED_INBOUND_OVERRIDECALL_RESULT_ANSWERED_LINKCALL_SUSPENDED_RESUMEDCALL_RESULT_ANSWERED_HANGUPCALL_RESULT_ANSWERED_VOICEMAILCALL_RESULT_MACHINECALL_RESULT_MACHINE_DELIVEREDCALL_RESULT_MACHINE_HANGUPCALL_RESULT_MACHINE_FAILEDCALL_RESULT_FAXCALL_RESULT_FAX_DELIVEREDCALL_RESULT_BUSYCALL_RESULT_NO_ANSWERCALL_RESULT_INVALIDCALL_RESULT_INVALID_INCOMPLETE_NUMBERCALL_RESULT_INVALID_UNKNOWN_PREFIXCALL_RESULT_INVALID_UNKNOWN_PREFIX_NPACALL_RESULT_INVALID_UNKNOWN_PREFIX_NPANXXCALL_RESULT_INVALID_PREFIX_NPANXX_NOT_FOUNDCALL_RESULT_INVALID_NO_ROUTECALL_RESULT_INVALID_DISCONNECTEDCALL_RESULT_INVALID_DISCONNECTED_SKIPTRACECALL_RESULT_FAILEDCALL_RESULT_FAILED_NO_LINESCALL_RESULT_FAILED_CIRCUITS_BUSYCALL_RESULT_FAILED_REFUSEDCALL_RESULT_FAILED_REFUSED_LEGALCALL_RESULT_FAILED_REFUSED_TECHNICALCALL_RESULT_FAILED_INTERNAL_ERRORCALL_RESULT_FAILED_REFUSED_RETRIES_EXHAUSTEDCALL_RESULT_FAILED_REFUSED_BLOCKCALL_RESULT_CANCELEDCALL_RESULT_CANCELED_TIMEZONECALL_RESULT_CANCELED_TIMEOUTCALL_RESULT_CANCELED_DNCLCALL_RESULT_CANCELED_CELLULAR_DNCLCALL_RESULT_CANCELED_DNCL_ZIP_CODECALL_RESULT_CANCELED_MAX_RETRYCALL_RESULT_CANCELED_INCOMPLETE_NUMBER

caller_id

string

caller_id

optional

phone_number

string

phone_number

optional

country_code

string

country_code

optional

delivery_duration

integer <int32>

delivery_duration

optional

link_call_duration

integer <int32>

link_call_duration

optional

sip_code

integer <int32>

sip_code

optional

do_record

boolean

do_record

optional

recording_file_name

string

recording_file_name

optional

is_dial_validation_ok

boolean

is_dial_validation_ok

optional

WARNING: don't delete these fields randomly, the frontend checks the inverse
so reserved fields will trigger a false positive for the scrub. Most likely you
will need to hardcode the value to True in matrix-api (like custom calling rules)

is_time_zone_scrub_ok

boolean

is_time_zone_scrub_ok

optional

is_cell_phone_scrub_ok

boolean

is_cell_phone_scrub_ok

optional

is_custom_calling_rules_scrub_ok

boolean

is_custom_calling_rules_scrub_ok

optional

is_dncl_scrub_ok

boolean

is_dncl_scrub_ok

optional

use_global_time_zone_scrub

boolean

use_global_time_zone_scrub

optional

do_cell_phone_scrub

boolean

do_cell_phone_scrub

optional

do_dncl_scrub

boolean

do_dncl_scrub

optional

call_data_type

string

call_data_type

optional

caller_id_country_code

string

caller_id_country_code

optional

zip_code

string

zip_code

optional

is_preview_by_record

boolean

is_preview_by_record

optional

rule_set_name

string

rule_set_name

optional

is_natural_compliance_ok

boolean

is_natural_compliance_ok

optional

simple_meta_data

array[object (SimpleKeyValue) {2}]

simple_meta_data

optional

simple_result_meta_data

array[object (SimpleKeyValue) {2}]

simple_result_meta_data

optional

task_sid

integer <int64> | string

task_sid

optional

call_sid

integer <int64> | string

call_sid

optional

task_group_sid

integer <int64> | string

task_group_sid

optional

client_sid

integer <int64> | string

client_sid

optional

country_sid

integer <int64> | string

country_sid

optional

agent_sid

integer <int64> | string

agent_sid

optional

start_time

integer <int64> | string

start_time

optional

caller_id_country_sid

integer <int64> | string

caller_id_country_sid

optional

hunt_group_sid

integer <int64> | string

hunt_group_sid

optional

agent_session_sid

integer <int64> | string

agent_session_sid

optional

Example

{
  "call": {
    "result": "CALL_RESULT_UNKNOWN",
    "caller_id": "string",
    "phone_number": "string",
    "country_code": "string",
    "delivery_duration": 0,
    "link_call_duration": 0,
    "sip_code": 0,
    "do_record": true,
    "recording_file_name": "string",
    "is_dial_validation_ok": true,
    "is_time_zone_scrub_ok": true,
    "is_cell_phone_scrub_ok": true,
    "is_custom_calling_rules_scrub_ok": true,
    "is_dncl_scrub_ok": true,
    "use_global_time_zone_scrub": true,
    "do_cell_phone_scrub": true,
    "do_dncl_scrub": true,
    "call_data_type": "string",
    "caller_id_country_code": "string",
    "zip_code": "string",
    "is_preview_by_record": true,
    "rule_set_name": "string",
    "is_natural_compliance_ok": true,
    "simple_meta_data": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "simple_result_meta_data": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "task_sid": 0,
    "call_sid": 0,
    "task_group_sid": 0,
    "client_sid": 0,
    "country_sid": 0,
    "agent_sid": 0,
    "start_time": 0,
    "caller_id_country_sid": 0
  },
  "hunt_group_sid": 0,
  "agent_session_sid": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/p3api/placepreviewdialcall' \
--header 'Content-Type: application/json' \
--data-raw '{
    "call": {
        "result": "CALL_RESULT_UNKNOWN",
        "caller_id": "string",
        "phone_number": "string",
        "country_code": "string",
        "delivery_duration": 0,
        "link_call_duration": 0,
        "sip_code": 0,
        "do_record": true,
        "recording_file_name": "string",
        "is_dial_validation_ok": true,
        "is_time_zone_scrub_ok": true,
        "is_cell_phone_scrub_ok": true,
        "is_custom_calling_rules_scrub_ok": true,
        "is_dncl_scrub_ok": true,
        "use_global_time_zone_scrub": true,
        "do_cell_phone_scrub": true,
        "do_dncl_scrub": true,
        "call_data_type": "string",
        "caller_id_country_code": "string",
        "zip_code": "string",
        "is_preview_by_record": true,
        "rule_set_name": "string",
        "is_natural_compliance_ok": true,
        "simple_meta_data": [
            {
                "key": "string",
                "value": "string"
            }
        ],
        "simple_result_meta_data": [
            {
                "key": "string",
                "value": "string"
            }
        ],
        "task_sid": 0,
        "call_sid": 0,
        "task_group_sid": 0,
        "client_sid": 0,
        "country_sid": 0,
        "agent_sid": 0,
        "start_time": 0,
        "caller_id_country_sid": 0
    },
    "hunt_group_sid": 0,
    "agent_session_sid": 0
}'

Responses

🟢200OK

application/json

Success

Body

object {0}

Example

{}

🔴500Server Error

DownloadCallRecordings

CancelPreviewDialCall