SIP Client icon

SIP Client

SIP Client for Asterisk/Starface PBX integration

Call → Make Call

AI-generated

Summary

Initiate an outbound SIP call to a specified SIP URI using configured SIP client credentials.

Inputs

  • Target URI (required) — The SIP URI to call, e.g., sip:user@domain.com or sip:1234@pbx.company.com.
  • Additional Options — Optional settings including timeout (seconds), auto answer toggle, call recording enable, and custom SIP headers to include in the call request.

Output shape

a JSON object containing success status, a message, and detailed call information including call ID, target URI, call status, timestamps, and connection details.

The call initiation requires the SIP client to be registered; otherwise, the operation throws an error. The call status progresses from 'initiating' to 'ringing' to 'connected'. Errors during call setup return failure messages. The operation times out after 30 seconds if no definitive response is received.

Examples

Example 1: Make outbound call to user

Set 'Target URI' to the SIP address of the callee; optionally configure timeout, auto answer, record call, or custom SIP headers.

Links

Discussion