SIP Client icon

SIP Client

SIP Client for Asterisk/Starface PBX integration

Registration → Unregister

AI-generated

Summary

Unregister from the SIP server to terminate the current SIP registration session.

Inputs

  • Additional Options — Optional settings to customize the unregistration request, including timeout in seconds, auto-answer incoming calls, record calls, and adding custom SIP headers.

Output shape

a JSON object containing the result of the unregistration attempt, including a success boolean, a message string, and the current registration status data such as isRegistered flag, URI, server URI, and timestamp.

If unregistration succeeds, the SIP client stack is destroyed and registration status is updated accordingly. On failure, error details are included in the response.

Examples

Example 1: Using default timeout without additional options, unregister from a SIP server and receive confirmation of unregistration status.

No required parameters besides selecting resource='Registration' and operation='Unregister'. Additional options are all optional.

Links

Discussion