Telephony

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Telephony",
  "title": "Telephony",
  "type": "object",
  "description": "Request body to create an outbound `telephony` task routed through a configured outdial entry point. `outdialEntryPointId` is required. When `callback` is provided, its `type` must be `immediate` and `origin` must be `web`.\n\n**Migrating from v1:** The following fields have been renamed or restructured \u2014 `entryPointId` \u2192 `channelParams.outdialEntryPointId`; `destination` (string) \u2192 `destination.id`; `origin` (string) \u2192 `origin.id`; `attributes` \u2192 `globalVariables`; `customAttributes` (SIP headers) \u2192 `channelParams.sipHeaders`; `mediaType` \u2192 `channelType`; `callback.callbackOrigin` \u2192 `channelParams.callback.origin`; `callback.callbackType` \u2192 `channelParams.callback.type`.",
  "required": [
    "origin",
    "destination",
    "channelType",
    "channelParams"
  ],
  "properties": {
    "origin": {
      "title": "Origin",
      "type": "object",
      "description": "Origin of the outbound telephony task. May be the agent's information or a configured outbound ANI in the organization.",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Outbound ANI or agent identifier used for the telephony call.",
          "example": "+18000000000"
        },
        "name": {
          "type": "string",
          "nullable": true,
          "description": "Optional display name. May be omitted or null for telephony tasks.",
          "example": null
        }
      }
    },
    "destination": {
      "title": "Destination",
      "type": "object",
      "description": "Destination for the telephony task. The `type` must be `dialNumber`.",
      "required": [
        "id",
        "type"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The dial number to call. **Migrating from v1:** Previously the top-level `destination` field (plain string).",
          "example": "+19780000000"
        },
        "type": {
          "type": "string",
          "description": "Must be `dialNumber` for `telephony` tasks.",
          "enum": [
            "businessAddress",
            "dialNumber"
          ],
          "example": "dialNumber"
        }
      }
    },
    "channelType": {
      "type": "string",
      "enum": [
        "telephony"
      ],
      "description": "Discriminator field. Must be `telephony` for voice task creation. **Migrating from v1:** Previously named `mediaType`.",
      "example": "telephony"
    },
    "channel": {
      "type": "string",
      "nullable": true,
      "description": "Not applicable for telephony tasks. May be omitted or set to `null`.",
      "example": null
    },
    "flowSettings": {
      "$ref": "#/components/schemas/FlowSettings"
    },
    "globalVariables": {
      "$ref": "#/components/schemas/GlobalVariables"
    },
    "channelParams": {
      "$ref": "#/components/schemas/TelephonyParams"
    }
  },
  "example": {
    "origin": {
      "id": "+18000000000",
      "name": null
    },
    "destination": {
      "id": "+19780000000",
      "type": "dialNumber"
    },
    "channelType": "telephony",
    "channelParams": {
      "type": "telephony",
      "outdialEntryPointId": "aef6455f-ccd6-4261-bb00-e80f845c01b0",
      "outboundType": "CALLBACK",
      "callback": {
        "type": "immediate",
        "origin": "web",
        "number": "+19780000000"
      }
    }
  }
}