Server events

1
{
2
  "message": {
3
    "type": "<server-message-type>",
4
    "call": { /* Call Object */ },
5
    /* other fields depending on type */
6
  }
7
}

1
{
2
  "model": {
3
    "provider": "openai",
4
    "model": "gpt-4o",
5
    "functions": [
6
      {
7
        "name": "sendEmail",
8
        "description": "Used to send an email to a client.",
9
        "parameters": {
10
          "type": "object",
11
          "properties": {
12
            "emailAddress": { "type": "string" },
13
            "message": { "type": "string" }
14
          },
15
          "required": ["emailAddress", "message"]
16
        }
17
      }
18
    ]
19
  }
20
}

1
{
2
  "message": {
3
    "type": "tool-calls",
4
    "call": { /* Call Object */ },
5
    "toolWithToolCallList": [
6
      {
7
        "name": "sendEmail",
8
        "toolCall": { "id": "abc123", "parameters": { "emailAddress": "john@example.com", "message": "Hi!" } }
9
      }
10
    ],
11
    "toolCallList": [
12
      { "id": "abc123", "name": "sendEmail", "parameters": { "emailAddress": "john@example.com", "message": "Hi!" } }
13
    ]
14
  }
15
}

1
{
2
  "results": [
3
    {
4
      "name": "sendEmail",
5
      "toolCallId": "abc123",
6
      "result": "{ \"status\": \"sent\" }"
7
    }
8
  ]
9
}

1
{
2
  "message": {
3
    "type": "assistant-request",
4
    "call": { /* Call Object */ }
5
  }
6
}

1
{ "assistantId": "your-saved-assistant-id" }

1
{
2
  "assistant": {
3
    "firstMessage": "Hey Ryan, how are you?",
4
    "model": {
5
      "provider": "openai",
6
      "model": "gpt-4o",
7
      "messages": [
8
        { "role": "system", "content": "You're Ryan's assistant..." }
9
      ]
10
    }
11
  }
12
}

1
{ "destination": { "type": "number", "number": "+11234567890" } }

1
{
2
  "destination": {
3
    "type": "number",
4
    "number": "+14155552671",
5
    "callerId": "{{phoneNumber.number}}",
6
    "extension": "101",
7
    "message": "Connecting you to support."
8
  }
9
}

1
{
2
  "destination": {
3
    "type": "sip",
4
    "sipUri": "sip:support@example.com",
5
    "sipHeaders": { "X-Account": "gold" },
6
    "message": "Transferring you now."
7
  }
8
}

1
{ "error": "Sorry, not enough credits on your account, please refill." }

1
{
2
  "message": {
3
    "type": "status-update",
4
    "call": { /* Call Object */ },
5
    "status": "ended"
6
  }
7
}

1
{
2
  "message": {
3
    "type": "end-of-call-report",
4
    "endedReason": "hangup",
5
    "call": { /* Call Object */ },
6
    "artifact": {
7
      "recording": { /* Recording object with URLs */ },
8
      "transcript": "AI: How can I help? User: What's the weather? ...",
9
      "messages": [
10
        { "role": "assistant", "message": "How can I help?" },
11
        { "role": "user", "message": "What's the weather?" }
12
      ]
13
    }
14
  }
15
}

1
{
2
  "message": {
3
    "type": "hang",
4
    "call": { /* Call Object */ }
5
  }
6
}

1
{
2
  "message": {
3
    "type": "conversation-update",
4
    "messages": [ /* current conversation messages */ ],
5
    "messagesOpenAIFormatted": [ /* openai-formatted messages */ ]
6
  }
7
}

1
{
2
  "message": {
3
    "type": "transcript",
4
    "role": "user",
5
    "transcriptType": "partial",
6
    "transcript": "I'd like to book...",
7
    "isFiltered": false,
8
    "detectedThreats": [],
9
    "originalTranscript": "I'd like to book..."
10
  }
11
}

1
{
2
  "message": {
3
    "type": "speech-update",
4
    "status": "started",
5
    "role": "assistant",
6
    "turn": 2
7
  }
8
}

1
{
2
  "message": {
3
    "type": "model-output",
4
    "output": { /* token or tool call */ }
5
  }
6
}

1
{
2
  "message": {
3
    "type": "transfer-destination-request",
4
    "call": { /* Call Object */ }
5
  }
6
}

1
{
2
  "destination": { "type": "number", "number": "+11234567890" },
3
  "message": { "type": "request-start", "message": "Transferring you now" }
4
}

1
{
2
  "message": {
3
    "type": "transfer-update",
4
    "destination": { /* assistant | number | sip */ }
5
  }
6
}

1
{
2
  "message": {
3
    "type": "user-interrupted"
4
  }
5
}

1
{
2
  "message": {
3
    "type": "language-change-detected",
4
    "language": "es"
5
  }
6
}

1
{
2
  "message": {
3
    "type": "phone-call-control",
4
    "request": "forward",
5
    "destination": { "type": "sip", "sipUri": "sip:agent@example.com" }
6
  }
7
}

1
{
2
  "message": {
3
    "type": "phone-call-control",
4
    "request": "hang-up"
5
  }
6
}

1
{
2
  "message": {
3
    "type": "knowledge-base-request",
4
    "messages": [ /* conversation so far */ ],
5
    "messagesOpenAIFormatted": [ /* openai-formatted messages */ ]
6
  }
7
}

1
{
2
  "documents": [
3
    { "content": "Return policy is 30 days...", "similarity": 0.92, "uuid": "doc-1" }
4
  ]
5
}

1
{
2
  "message": {
3
    "type": "voice-input",
4
    "input": "Hello, world!"
5
  }
6
}

1
{
2
  "message": {
3
    "type": "voice-request",
4
    "text": "Hello, world!",
5
    "sampleRate": 24000
6
  }
7
}

1
{
2
  "message": {
3
    "type": "call.endpointing.request",
4
    "messagesOpenAIFormatted": [ /* openai-formatted messages */ ]
5
  }
6
}

1
{ "timeoutSeconds": 0.5 }

1
{ "message": { "type": "chat.created", "chat": { /* Chat */ } } }

1
{ "message": { "type": "session.created", "session": { /* Session */ } } }