Call ai gather partial results

This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.

WEBHOOK CallAIGatherPartialResults

Example

{
  "data": {
    "record_type": "event",
    "event_type": "call.ai_gather.partial_results",
    "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
    "occurred_at": "2018-02-02T22:25:27.521992Z",
    "payload": {
      "call_control_id": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ",
      "connection_id": "7267xxxxxxxxxxxxxx",
      "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
      "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
      "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
      "from": "[phone]",
      "to": "[phone]",
      "message_history": [
        {
          "content": "Hello, can you tell me your age and where you live?",
          "role": "assistant"
        },
        {
          "content": "Hello, I'm 29 and I live in Paris?",
          "role": "user"
        }
      ],
      "partial_results": {
        "age": 29,
        "city": "Paris"
      }
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

telnyx-timestamp · integer<int64> · required

Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp Unix timestamp for replay attack prevention

telnyx-signature-ed25519 · string · required

Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature Ed25519 signature of timestamp|payload for verification

Body

application/json

data · Call AI Gather Partial Results · object

Show child attributes

Example:

{
  "record_type": "event",
  "event_type": "call.ai_gather.partial_results",
  "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
  "occurred_at": "2018-02-02T22:25:27.521992Z",
  "payload": {
    "call_control_id": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ",
    "connection_id": "7267xxxxxxxxxxxxxx",
    "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
    "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
    "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
    "from": "[phone]",
    "to": "[phone]",
    "message_history": [
      {
        "content": "Hello, can you tell me your age and where you live?",
        "role": "assistant"
      },
      {
        "content": "Hello, I'm 29 and I live in Paris?",
        "role": "user"
      }
    ],
    "partial_results": { "age": 29, "city": "Paris" }
  }
}

Response

200

The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.