SIP Client icon

SIP Client

SIP Client for Asterisk/Starface PBX integration

Actions8

Call → Get Call Status

AI-generated

Summary

Get the current status of a specific SIP call identified by its Call ID.

Inputs

  • Call ID (required) — The unique identifier of the call whose status you want to retrieve.
  • Additional Options — Optional parameters including timeout (seconds), auto answer toggle, call recording enable, and custom SIP headers.

Output shape

a JSON object containing a 'success' boolean and a 'call' object with the call's status details.

The output includes complete call information if found; if the call ID does not exist, the operation throws an error. Optional additional options influence internal behavior but do not affect the response shape.

Examples

Example 1: Retrieve the status of an active or past SIP call by specifying its Call ID to monitor call progress or state.

Pass the Call ID as a required parameter; optionally include timeout, auto answer, record call, or custom headers in Additional Options.

Links

Discussion