GetQueueConfig - TCN API

Gets the details for the queue config for the given @client_sid with
the given @name. If @merge is true, the config data will be merged
with the default config data.
Required Permissions:
ORG_VIEW
Errors:
grpc.Internal: An unexpected error occurred getting the config data.
grpc.InvalidArgument: the given config name was invalid.
Request Code Samples
Shell
JavaScript
Java
Swift
PHP
Python
HTTP
Objective-C
Ruby
OCaml
Dart
Responses
🟢200OK
application/json
Success
Body
Example
{
    "config": {
        "name": "string",
        "config_modified": "1s",
        "sounds_modified": "1s",
        "sounds_language": "string",
        "sounds_gender": "string",
        "announcement_mixing": {
            "inbound": {
                "option": "ANNOUNCEMENT_MIXING_OPTION_MUTE_HOLD_MUSIC"
            },
            "outbound": {
                "option": "ANNOUNCEMENT_MIXING_OPTION_MUTE_HOLD_MUSIC"
            },
            "manual": {
                "option": "ANNOUNCEMENT_MIXING_OPTION_MUTE_HOLD_MUSIC"
            },
            "preview": {
                "option": "ANNOUNCEMENT_MIXING_OPTION_MUTE_HOLD_MUSIC"
            },
            "any": {
                "option": "ANNOUNCEMENT_MIXING_OPTION_MUTE_HOLD_MUSIC"
            }
        },
        "position_announcements": {
            "inbound": {
                "config": {
                    "first_seconds": 0,
                    "repeating_seconds": 0,
                    "threshold": 0
                }
            },
            "outbound": {
                "config": {
                    "first_seconds": 0,
                    "repeating_seconds": 0,
                    "threshold": 0
                }
            },
            "manual": {
                "config": {
                    "first_seconds": 0,
                    "repeating_seconds": 0,
                    "threshold": 0
                }
            },
            "preview": {
                "config": {
                    "first_seconds": 0,
                    "repeating_seconds": 0,
                    "threshold": 0
                }
            },
            "any": {
                "config": {
                    "first_seconds": 0,
                    "repeating_seconds": 0,
                    "threshold": 0
                }
            }
        },
        "wait_time_announcements": {
            "inbound": {
                "config": {
                    "first_seconds": 0,
                    "repeating_seconds": 0,
                    "threshold": 0
                }
            },
            "outbound": {
                "config": {
                    "first_seconds": 0,
                    "repeating_seconds": 0,
                    "threshold": 0
                }
            },
            "manual": {
                "config": {
                    "first_seconds": 0,
                    "repeating_seconds": 0,
                    "threshold": 0
                }
            },
            "preview": {
                "config": {
                    "first_seconds": 0,
                    "repeating_seconds": 0,
                    "threshold": 0
                }
            },
            "any": {
                "config": {
                    "first_seconds": 0,
                    "repeating_seconds": 0,
                    "threshold": 0
                }
            }
        },
        "attention_tones": {
            "inbound": {
                "config": {
                    "agent_status_paused": true,
                    "agent_status_wrap_up": true,
                    "tones": [
                        {
                            "pause": "string"
                        }
                    ]
                }
            },
            "outbound": {
                "config": {
                    "agent_status_paused": true,
                    "agent_status_wrap_up": true,
                    "tones": [
                        {
                            "pause": "string"
                        }
                    ]
                }
            },
            "manual": {
                "config": {
                    "agent_status_paused": true,
                    "agent_status_wrap_up": true,
                    "tones": [
                        {
                            "pause": "string"
                        }
                    ]
                }
            },
            "preview": {
                "config": {
                    "agent_status_paused": true,
                    "agent_status_wrap_up": true,
                    "tones": [
                        {
                            "pause": "string"
                        }
                    ]
                }
            },
            "any": {
                "config": {
                    "agent_status_paused": true,
                    "agent_status_wrap_up": true,
                    "tones": [
                        {
                            "pause": "string"
                        }
                    ]
                }
            }
        },
        "in_queue_conditions": {
            "no_agents_logged_in": {
                "inbound": {
                    "actions": [
                        {
                            "hang_up": {}
                        }
                    ]
                },
                "outbound": {
                    "actions": [
                        {
                            "hang_up": {}
                        }
                    ]
                },
                "manual": {
                    "actions": [
                        {
                            "hang_up": {}
                        }
                    ]
                },
                "preview": {
                    "actions": [
                        {
                            "hang_up": {}
                        }
                    ]
                },
                "any": {
                    "actions": [
                        {
                            "hang_up": {}
                        }
                    ]
                }
            },
            "no_agents_with_required_skills_logged_in": {
                "inbound": {
                    "actions": [
                        {
                            "add_skills": {
                                "p3_ids": [
                                    "string"
                                ]
                            }
                        }
                    ]
                },
                "outbound": {
                    "actions": [
                        {
                            "add_skills": {
                                "p3_ids": [
                                    "string"
                                ]
                            }
                        }
                    ]
                },
                "manual": {
                    "actions": [
                        {
                            "add_skills": {
                                "p3_ids": [
                                    "string"
                                ]
                            }
                        }
                    ]
                },
                "preview": {
                    "actions": [
                        {
                            "add_skills": {
                                "p3_ids": [
                                    "string"
                                ]
                            }
                        }
                    ]
                },
                "any": {
                    "actions": [
                        {
                            "add_skills": {
                                "p3_ids": [
                                    "string"
                                ]
                            }
                        }
                    ]
                }
            },
            "no_agents_available": {
                "inbound": {
                    "actions": [
                        {
                            "hang_up": {}
                        }
                    ]
                },
                "outbound": {
                    "actions": [
                        {
                            "hang_up": {}
                        }
                    ]
                },
                "manual": {
                    "actions": [
                        {
                            "hang_up": {}
                        }
                    ]
                },
                "preview": {
                    "actions": [
                        {
                            "hang_up": {}
                        }
                    ]
                },
                "any": {
                    "actions": [
                        {
                            "hang_up": {}
                        }
                    ]
                }
            },
            "no_agents_with_required_skills_available": {
                "inbound": {
                    "actions": [
                        {
                            "add_skills": {
                                "p3_ids": [
                                    "string"
                                ]
                            }
                        }
                    ]
                },
                "outbound": {
                    "actions": [
                        {
                            "add_skills": {
                                "p3_ids": [
                                    "string"
                                ]
                            }
                        }
                    ]
                },
                "manual": {
                    "actions": [
                        {
                            "add_skills": {
                                "p3_ids": [
                                    "string"
                                ]
                            }
                        }
                    ]
                },
                "preview": {
                    "actions": [
                        {
                            "add_skills": {
                                "p3_ids": [
                                    "string"
                                ]
                            }
                        }
                    ]
                },
                "any": {
                    "actions": [
                        {
                            "add_skills": {
                                "p3_ids": [
                                    "string"
                                ]
                            }
                        }
                    ]
                }
            },
            "pbx_ringing": {
                "inbound": {
                    "actions": [
                        {
                            "add_skills": {
                                "p3_ids": [
                                    "string"
                                ]
                            }
                        }
                    ]
                },
                "outbound": {
                    "actions": [
                        {
                            "add_skills": {
                                "p3_ids": [
                                    "string"
                                ]
                            }
                        }
                    ]
                },
                "manual": {
                    "actions": [
                        {
                            "add_skills": {
                                "p3_ids": [
                                    "string"
                                ]
                            }
                        }
                    ]
                },
                "preview": {
                    "actions": [
                        {
                            "add_skills": {
                                "p3_ids": [
                                    "string"
                                ]
                            }
                        }
                    ]
                },
                "any": {
                    "actions": [
                        {
                            "add_skills": {
                                "p3_ids": [
                                    "string"
                                ]
                            }
                        }
                    ]
                }
            },
            "agent_lost": {
                "inbound": {
                    "actions": [
                        {
                            "add_skills": {
                                "p3_ids": [
                                    "string"
                                ]
                            }
                        }
                    ]
                },
                "outbound": {
                    "actions": [
                        {
                            "add_skills": {
                                "p3_ids": [
                                    "string"
                                ]
                            }
                        }
                    ]
                },
                "manual": {
                    "actions": [
                        {
                            "add_skills": {
                                "p3_ids": [
                                    "string"
                                ]
                            }
                        }
                    ]
                },
                "preview": {
                    "actions": [
                        {
                            "add_skills": {
                                "p3_ids": [
                                    "string"
                                ]
                            }
                        }
                    ]
                },
                "any": {
                    "actions": [
                        {
                            "add_skills": {
                                "p3_ids": [
                                    "string"
                                ]
                            }
                        }
                    ]
                }
            },
            "default": {
                "inbound": {
                    "actions": [
                        {
                            "hang_up": {}
                        }
                    ]
                },
                "outbound": {
                    "actions": [
                        {
                            "hang_up": {}
                        }
                    ]
                },
                "manual": {
                    "actions": [
                        {
                            "hang_up": {}
                        }
                    ]
                },
                "preview": {
                    "actions": [
                        {
                            "hang_up": {}
                        }
                    ]
                },
                "any": {
                    "actions": [
                        {
                            "hang_up": {}
                        }
                    ]
                }
            }
        },
        "key_press_events": {
            "zero": {
                "inbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "outbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "manual": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "preview": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "any": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                }
            },
            "one": {
                "inbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "outbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "manual": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "preview": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "any": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                }
            },
            "two": {
                "inbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "outbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "manual": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "preview": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "any": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                }
            },
            "three": {
                "inbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "outbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "manual": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "preview": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "any": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                }
            },
            "four": {
                "inbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "outbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "manual": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "preview": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "any": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                }
            },
            "five": {
                "inbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "outbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "manual": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "preview": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "any": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                }
            },
            "six": {
                "inbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "outbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "manual": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "preview": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "any": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                }
            },
            "seven": {
                "inbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "outbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "manual": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "preview": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "any": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                }
            },
            "eight": {
                "inbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "outbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "manual": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "preview": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "any": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                }
            },
            "nine": {
                "inbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "outbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "manual": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "preview": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "any": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                }
            },
            "asterisk": {
                "inbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "outbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "manual": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "preview": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "any": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                }
            },
            "hashtag": {
                "inbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "outbound": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "manual": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "preview": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                },
                "any": {
                    "add_skills": {
                        "p3_ids": [
                            "string"
                        ]
                    }
                }
            }
        },
        "pbx_ring_strategy": {
            "inbound": {
                "agent_score": 0
            },
            "outbound": {
                "agent_score": 0
            },
            "any": {
                "agent_score": 0
            }
        },
        "queue_monitoring_silence_wait_times": {
            "first_milliseconds": 0,
            "second_milliseconds": 0
        },
        "callback_timeout_minutes": 0,
        "number_update": true,
        "inbound_override": "INBOUND_OVERRIDE_OPTION_DO_NOTHING",
        "intercom_connection": "INTERCOM_CONNECTION_AUTOMATIC"
    }
}
🟢200Success