Vapi via SIP

​

Setup

1. In Vapi, go to Phone Numbers and click Create a new phone number. Choose Free Vapi SIP and enter the SIP identifier you want in the URI.

2. Set up a webhook that accepts messages for everything you want to track from your agent along with the end of call report from VAPI. The webhook format that VAPI sends can be found here. To get started you can set up the webhook (Server URL) under the SIP URI but you can also specify the webhook URL at different levels.

3. After your webhook is set up and you track the relevant tool calls and metadata from your agent, you can pull the simulation result ID from the end-of-call-report message that VAPI sends to your webhook.

{
  "message": {
    "timestamp": 1759863299084,
    "type": "end-of-call-report",
    //....
    "assistant": {
      //....
      "variableValues": {
        "cid": "....",
        "account-sid": "....",
        "from-number": "+18888888888",
        "special-item": "Apricots", // other SIP headers that could be sent from Bluejay
        "simulation-run-id": "5678",
        "simulation-result-id": "1234"
      }
    }
  }
}

4. You can now use this simulation result ID to update the simulation result with the tool calls and metadata you have collected from your agent by calling the /v1/update-simulation-result endpoint.

import requests

url = "https://api.getbluejay.ai/v1/update-simulation-result"
headers = {
    "X-API-Key": "<your-api-key>"
}

# Pass in the simulation result ID, tool calls, and metadata collected from VAPI
def update_simulation_result(simulation_result_id, tool_calls, metadata):
    data = {
        "simulation_result_id": simulation_result_id,
        "tool_calls": tool_calls,
        "metadata": metadata
    }
    response = requests.post(url, headers=headers, json=data)
    return response.json()