Telnyx

POST

CallAIGatherEnded

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 Ended · object

Show child attributes

data.record_type

enum<string>

Identifies the type of the resource.

Available options:

event

Example:

"event"

data.event_type

enum<string>

The type of event being delivered.

Available options:

call.ai_gather.ended

Example:

"call.ai_gather.ended"

data.id

string<uuid>

Identifies the type of resource.

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"

data.occurred_at

string<date-time>

ISO 8601 datetime of when the event occurred.

Example:

"2018-02-02T22:25:27.521992Z"

data.payload

object

Show child attributes

data.payload.call_control_id

string

Call ID used to issue commands via Call Control API.

Example:

"v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ"

data.payload.connection_id

string

Telnyx connection ID used in the call.

Example:

"7267xxxxxxxxxxxxxx"

data.payload.call_leg_id

string

ID that is unique to the call and can be used to correlate webhook events.

Example:

"428c31b6-7af4-4bcb-b7f5-5013ef9657c1"

data.payload.call_session_id

string

ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.

Example:

"428c31b6-abf3-3bc1-b7f4-5013ef9657c1"

data.payload.client_state

string

State received from a command.

Example:

"aGF2ZSBhIG5pY2UgZGF5ID1d"

data.payload.from

string

Number or SIP URI placing the call.

Example:

"+35319605860"

data.payload.to

string

Destination number or SIP URI of the call.

Example:

"+13129457420"

data.payload.message_history

object[]

The history of the messages exchanged during the AI gather

Show child attributes

data.payload.message_history.content

string

The content of the message

Example:

"Hello, I'm 29 and I live in Paris."

data.payload.message_history.role

enum<string>

The role of the message sender

Available options:

assistant,

user

Example:

"user"

data.payload.result

object

The result of the AI gather, its type depends of the parameters provided in the command

Example:

{ "age": 29, "city": "Paris" }

data.payload.status

enum<string>

Reflects how command ended.

Available options:

valid,

invalid

Example:

"valid"

Example:

{
  "record_type": "event",
  "event_type": "call.ai_gather.ended",
  "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": "+35319605860",
    "to": "+35319605860",
    "status": "valid",
    "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"
      }
    ],
    "result": { "age": 29, "city": "Paris" }
  }
}

Response

200

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

Update queued call Call ai gather message history updated

⌘I

AI

Real-Time Communications

WebRTC

Messaging

Numbers & Identity

IoT & Wireless

Networking

Storage & Data

Account & Billing

Other Products

SETI

OAuth

Call ai gather ended

Authorizations

Headers

Body

Response