GetHuntGroupClientInfoDisplayTemplate

GetHuntGroupClientInfoDisplayTemplate returns the client info display template for a given hunt group.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Request message for GetHuntGroupClientInfoDisplayTemplate RPC method.

hunt_group_sid

integer <int64> | string

hunt_group_sid

optional

The hunt group sid of the desired client info display template

Example

{
  "hunt_group_sid": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Response message for GetHuntGroupClientInfoDisplayTemplate RPC method.

template

object (ClientInfoDisplayTemplate)

template

optional

The template info of the client info display template

dialed_number_field_style

object (DialedNumberFieldStyle)

dialed_number_field_style

optional

The dialed number field style of a client info display template

template_category

enum<string>

template_category

optional

The template type

Allowed values:

TEMPLATE_CATEGORY_UNSPECIFIEDTEMPLATE_CATEGORY_HUNT_GROUPTEMPLATE_CATEGORY_CAMPAIGN

template_sid

string

template_sid

deprecated

The template sid of the client info display template

name

string

name

optional

The name of the client info display template

description

string

description

optional

The description of the client info display template

display_all_fields

boolean

display_all_fields

optional

Bool used to determine whether to show all fields in a client info display template

contact_field_styles

array[object (ContactFieldStyle) {2}]

contact_field_styles

optional

A list of Contact Field Styles for a client info display template

client_info_display_template_sid

integer <int64> | string

client_info_display_template_sid

optional

The sid of the client info display template

hunt_group_sid

integer <int64> | string

hunt_group_sid

optional

The sid of the hunt group which the client info display template is associated with

Example

{
  "template": {
    "dialed_number_field_style": {
      "field_style": {
        "text_color": "string",
        "background_color": "string",
        "allow_agent_copy": true
      },
      "display_to_agent": true
    },
    "template_category": "TEMPLATE_CATEGORY_UNSPECIFIED",
    "template_sid": "string",
    "name": "string",
    "description": "string",
    "display_all_fields": true,
    "contact_field_styles": [
      {
        "field_style": {
          "text_color": "string",
          "background_color": "string",
          "allow_agent_copy": true
        },
        "description_id": 0
      }
    ],
    "client_info_display_template_sid": 0,
    "hunt_group_sid": 0
  }
}

🔴500Server Error