Wipple CPaaS
Menu
Guide
Introduction Getting started
Functions
Overview Agent Alert Answer Conference Config Dequeue Dial Dialogflow DTMF Dub Enqueue Gather Hangup Leave Listen LLM Pause Play Rasa Recognizer Redirect Say SIP Decline SIP Refer SIP Request Synthesizer Tag Transcribe Transfer
REST API
About the REST API Create a call List calls Get a call Update a call Delete a call Get call count List conferences Start conference listen Stop conference listen List queues
Webhooks
Overview New Call (POST) New Call (GET) Client Authentication Client Tool Request
Functions / SIP Request

SIP Request

{
  "verb": "sip:request",
  "method": "INFO",
  "headers": {
    "X-Metadata": "my sip metadata"
  }
  "actionHook": "/info"
}

Parameters

methodstringrequired

SIP method, should be one of INFO, MESSAGE, or NOTIFY.

actionHookstring

A webhook to call when the SIP request has completed.

bodystring

The body of the SIP request, if any.

headersobject

An object containing headers (key-value pairs) to include with the SIP request.

The sip:request Function completes when a response is received from the far end.

actionHook properties

The actionHook provides the status code of the sip response:

  • result: 'success' or 'failed'
  • sipStatus: sip status code of response
  • err: error message, in the case of failure
← SIP ReferSynthesizer →