PhoneCall

Overview

Technical name: PhoneCall · ActionType: 7

Use PhoneCall when an inbound telephone interaction begins and the call workflow needs the configured IH result.

Requirements and Inputs

Input	Applicability
ActionKeyToken	Required: an ActionKey provisioned for PhoneCall (7).
Caller phone / ANI (43)	Supply the caller identity agreed for the integration.
Dialed number / DNIS (44)	Supply the destination number agreed for the call workflow.

All requests use the shared User Action endpoint. Provisioning determines required identity and destination signals. Optional fields are defined in Action Fields.

Request Examples

Replace YOUR_ACTION_KEY with the correctly provisioned token. The first example shows the basic shape for this context; add all signals required by your integration. These examples do not provision an action or guarantee a production-valid identity.

Basic request

{
  "ActionKeyToken": "YOUR_ACTION_KEY",
  "Values": [
    {
      "SignalValueType": 43,
      "DataType": 0,
      "UnitType": 0,
      "Value": "12025550123",
      "OptionIDs": {}
    },
    {
      "SignalValueType": 44,
      "DataType": 0,
      "UnitType": 0,
      "Value": "12025550100",
      "OptionIDs": {}
    }
  ]
}

With additional context

{
  "ActionKeyToken": "YOUR_ACTION_KEY",
  "Values": [
    {
      "SignalValueType": 43,
      "DataType": 0,
      "UnitType": 0,
      "Value": "12025550123",
      "OptionIDs": {}
    },
    {
      "SignalValueType": 44,
      "DataType": 0,
      "UnitType": 0,
      "Value": "12025550100",
      "OptionIDs": {}
    },
    {
      "SignalValueType": 403,
      "DataType": 0,
      "UnitType": 0,
      "Value": "example-call-001",
      "OptionIDs": {}
    },
    {
      "SignalValueType": 400,
      "DataType": 0,
      "UnitType": 0,
      "Value": "2026-10-21T12:00:00Z",
      "OptionIDs": {}
    }
  ]
}

Expected Result

The shared response may contain Result, correlation identifiers, and configured signals. Read the returned values according to the configured model and product. Do not assume every action returns an IH Score or the same response fields.

See the response contract and API Results and Errors. An HTTP response or accepted event alone does not prove downstream delivery or a business outcome.

Processing and Feedback

Submit at the call workflow point agreed for the integration, before applying the returned treatment. Preserve call/session identifiers for subsequent outcomes. Use a separate Disposition ActionKey to report completion.

When reporting an observed outcome, use Disposition (19) and its correlation rules. Never reuse a different ActionType ActionKey as an outcome key.

Delivery and Troubleshooting

This guide documents API submission. Use only other delivery methods explicitly provisioned for your integration. If a request fails, verify the API key, the exact ActionKey type, required signal values, and the actual HTTP and API result. Review retry/correlation behavior before resubmitting after a timeout.