GetScriptOrResponses

Gets the campaign or huntgroup script for the given agent's current hunt
group. If no script is found, it gets the hunt group responses for the
agent's current hunt group. It also does a mail merge with the found script
or responses (if able).

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

data

object (MailMergeData)

data

optional

call_type

enum<string>

call_type

optional

Allowed values:

INBOUNDOUTBOUNDPREVIEWMANUALMAC

scheduled_callback_id

string

scheduled_callback_id

optional

call_sid

integer <int64> | string

call_sid

optional

Example

{
  "data": {
    "call_type": "INBOUND",
    "scheduled_callback_id": "string",
    "call_sid": 0
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

scripts

object (HuntGroupScript)

scripts

optional

name

string

name

optional

description

string

description

optional

auto_script_progression

boolean

auto_script_progression

optional

script_category

string

script_category

optional

act

array[object (Act) {6}]

act

optional

responses

array[object (HuntGroupResponse) {10}]

responses

optional

hunt_group_sid

optional

Wrapper message for int64.

The JSON representation for Int64Value is JSON string.

type

string

type

optional

Wrapper message for string.

The JSON representation for StringValue is JSON string.

name

string

name

optional

Wrapper message for string.

The JSON representation for StringValue is JSON string.

description

string

description

optional

Wrapper message for string.

The JSON representation for StringValue is JSON string.

order

number

order

optional

Wrapper message for int32.

The JSON representation for Int32Value is JSON number.

required

boolean

required

optional

Wrapper message for bool.

The JSON representation for BoolValue is JSON true and false.

default_value

string

default_value

optional

Wrapper message for string.

The JSON representation for StringValue is JSON string.

manual_dial

object (ManualDialSettings)

manual_dial

optional

hunt_group_response_sid

integer <int64> | string

hunt_group_response_sid

optional

options

array[string]

options

optional

Example

{
  "scripts": {
    "name": "string",
    "description": "string",
    "auto_script_progression": true,
    "script_category": "string",
    "act": [
      {
        "disposition": [
          {
            "required": true,
            "type": "string",
            "header": "string",
            "prompt": "string",
            "defaultValue": "string",
            "bypass_auto_script_progression": true,
            "order": 0,
            "response_options": [
              "string"
            ]
          }
        ],
        "verbiage": [
          {
            "header": "string",
            "body": "string",
            "order": 0
          }
        ],
        "conditional_navigation": [
          {
            "complex_boolean_expression_list": {
              "complex_boolean_expression": [
                {
                  "compare_expression_list": {
                    "simple_compare_expression": [
                      {
                        "operator_type": "string",
                        "value_key": "string",
                        "compare_value": "string"
                      }
                    ]
                  }
                }
              ]
            },
            "target_act_index": 0
          }
        ],
        "default_conditional_navigation_target": 0,
        "page_arrival_recording_control": 0,
        "page_exit_recording_control": 0
      }
    ]
  },
  "responses": [
    {
      "hunt_group_sid": "string",
      "type": "string",
      "name": "string",
      "description": "string",
      "order": 0,
      "required": true,
      "default_value": "string",
      "manual_dial": {
        "use_timezone_validation_zip": "FALSE",
        "manual_dial_data_dip_result_handling": "NONE",
        "data_dip_manual_dial_integration_handling": "NONE",
        "enabled": true,
        "show_outbound_phone_book": true,
        "show_caller_id_phone_book": true,
        "has_custom_caller_id": true,
        "default_caller_id": "string",
        "show_country_selector": true,
        "timezone_restrictions": true,
        "scrub_cell_phones": true,
        "call_recording": true,
        "agent_override_cell": true,
        "agent_override_ccr": true,
        "agent_override_dncl": true,
        "agent_override_timezone": true,
        "use_white_list": true,
        "use_random_caller_id": true,
        "display_caller_id_country_select": true,
        "use_caller_id_bucket": true,
        "agent_override_natural_compliance": true,
        "natural_compliance_rule_set_name": "string",
        "compliance_metadata": [
          {
            "name": "string",
            "required": true
          }
        ],
        "enable_metadata": true,
        "enable_reject_option_for_approvers": true,
        "enable_sip_address": true,
        "mask_manual_dial_caller_id": true,
        "enable_manual_dial_data_dip": "string",
        "default_country_sid": 0,
        "random_caller_id_bucket": 0,
        "default_caller_id_country_sid": 0,
        "manual_dial_data_dip_config": 0,
        "data_dip_manual_dial_integration": {
          "property1": "string",
          "property2": "string"
        }
      },
      "hunt_group_response_sid": 0,
      "options": [
        "string"
      ]
    }
  ]
}

🔴500Server Error