Prompt Buddy logoPrompt Buddy

openai · OpenAI Platform Docs

Realtime API with SIP

Teaches how to integrate the Realtime API with SIP trunking providers to handle incoming phone calls by configuring webhooks, accepting or rejecting calls via API endpoints, and managing sessions through WebSockets.

Import to Prompt Buddy

Derived skill

Files assembled from official documentation

Viewing SKILL.md

Realtime API with SIP

Teaches how to integrate the Realtime API with SIP trunking providers to handle incoming phone calls by configuring webhooks, accepting or rejecting calls via API endpoints, and managing sessions through WebSockets.

When To Use

Use when you need to connect a phone number to the Realtime API to automate voice interactions via SIP trunking providers like Twilio.

Reference Files

FileContainsUse For
SKILL.mdEntry point: scope, routing table, and workflow.Start here.
docs/realtime-api-with-sip-workflow-guide.mdA guide explaining how to connect phone calls to the Realtime API using SIP trunking providers like Twilio.Questions about a guide explaining how to connect phone calls to the Realtime API using SIP trunking providers like Twilio.
examples/realtime-api-with-sip-openai-realtime-api-sip-webhook-payload.textA sample HTTP POST request payload containing webhook headers and signature data for the Realtime API with SIP integration.Exact payloads, commands, or snippets shown in A sample HTTP POST request payload containing webhook headers and signature data for the Realtime API with SIP integr...
examples/realtime-api-with-sip-realtime-api-sip-accept-call-curl.bashA curl command to accept a Realtime API call via SIP using a POST request to the calls endpoint.Exact payloads, commands, or snippets shown in A curl command to accept a Realtime API call via SIP using a POST request to the calls endpoint.
examples/realtime-api-with-sip-openai-realtime-api-sip-reject-call-curl.bashA curl command demonstrating how to reject a Realtime API SIP call with a specific status code.Exact payloads, commands, or snippets shown in A curl command demonstrating how to reject a Realtime API SIP call with a specific status code.
examples/realtime-api-with-sip-realtime-api-sip-websocket-connection.javascriptA JavaScript example demonstrating how to establish a WebSocket connection to the Realtime API using a specific call ID for SIP integration.Exact payloads, commands, or snippets shown in A JavaScript example demonstrating how to establish a WebSocket connection to the Realtime API using a specific call...
examples/realtime-api-with-sip-realtime-api-sip-refer-curl-request.bashA curl command demonstrating how to send a SIP REFER request to the OpenAI Realtime API to redirect a call.Exact payloads, commands, or snippets shown in A curl command demonstrating how to send a SIP REFER request to the OpenAI Realtime API to redirect a call.
examples/realtime-api-with-sip-realtime-api-sip-hangup-curl.bashA curl command demonstrating how to hang up a Realtime API session via SIP using the hangup endpoint.Exact payloads, commands, or snippets shown in A curl command demonstrating how to hang up a Realtime API session via SIP using the hangup endpoint.
examples/realtime-api-with-sip-realtime-api-sip-flask.pythonA Python Flask application demonstrating how to handle Realtime API SIP integration using webhooks and OpenAI client.Exact payloads, commands, or snippets shown in A Python Flask application demonstrating how to handle Realtime API SIP integration using webhooks and OpenAI client.

What This Skill Covers

  • SIP is a protocol used to make phone calls over the internet. With SIP and the Realtime API you can direct incoming phone calls to the API.
  • Main sections: Overview, Accept the call, Reject the call, Monitor call events, WebSocket request.

Workflow

  1. Open the most relevant file under docs/ for the exact documented workflow and wording.
  2. Open schemas/ files for exact structured contracts.
  3. Open examples/ files for concrete requests, commands, snippets, and manifests.
  4. Do not add behavior or configuration that is not present in the attached source files.

Canonical source: https://developers.openai.com/api/docs/guides/realtime-sip.md