voice

List your originating numbers and the agent lines each one overrides

Every Telnyx DID your organization owns that can originate a bridge, with the spoken lines the conversational agent uses for calls placed from it. instructions is null when the number overrides nothing, which means it speaks every shipped template, that is the state of every number until you set one, and it is not an error. The value returned is the SCREENED value, i.e. exactly what will be spoken, not necessarily the bytes you sent: see the normalization note on PATCH. Requires the voice:bridge scope.

get/voice/bridge/numbers/instructions

Request

Base URL: https://corebee.ai/api/v1
URL: https://corebee.ai/api/v1/voice/bridge/numbers/instructions
Auth: HTTP bearer

Response

Example response

{
  "data": {
    "numbers": [
      {
        "from_number": "+17635550123",
        "instructions": {
          "templates": {
            "opening_preamble": "Thanks for taking the call, this is {dealership}",
            "state_purpose": "I'm calling on behalf of one of your customers.",
            "acknowledge_hold": "Of course, take your time. Here is the note I was given, {prepLine}"
          },
          "variables": {
            "dealership": "Gunn Honda",
            "department": "new car sales"
          }
        },
        "using_shipped_templates": true,
        "corridors": [
          {
            "corridor": "briefing",
            "template": "briefing_opening",
            "greeting_key": "briefing_opening_greeting",
            "preamble_key": "briefing_opening_preamble",
            "configured_by": [],
            "speaks": "shipped_wording"
          }
        ],
        "connection_status": "connected"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.