SIP Request

result: ‘success’ or ‘failed’
sipStatus: sip status code of response
err: error message, in the case of failure

Overview

The sip:request verb sends a SIP INFO, NOTIFY, or MESSAGE request during a call.

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

Parameter	Type	Required	Description
`method`	string	Yes	SIP method, should be one of `INFO`, `MESSAGE`, or `NOTIFY`.
`actionHook`	string	No	A webhook to call when the SIP request has completed.
`body`	string	No	The body of the SIP request, if any.
`headers`	object	No	An object containing headers (key-value pairs) to include with the SIP request.

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

The actionHook provides the status code of the sip response: