SIP Refer

1 {
2   "verb": "sip:refer",
3   "referTo": +15083084809,
4   "actionHook": "/action"
5 }

Parameters

referTo

stringRequired

A SIP URI or a phone number/user identifier.

actionHook

string

A webhook to call when the transfer has completed.

eventHook

string

A webhook to call when NOTIFY messages of follow-on call status are received.

headers

object

Additional SIP headers to include in the response.

referredBy

string

A SIP URI or a phone number/user identifier.
If not provided, it will default to the identity of the party being transferred.

The sip:refer verb completes when one of these conditions are met:

a failure response is received to the REFER
a 202 Accepted is received in response to the REFER, and a NOTIFY of the follow-on call status with a final call status is received.

The sip:refer has an action hook that will provide details of the final result, as well as an event hook that is called for every NOTIFY received after a successful REFER.

actionHook properties

The actionHook webhook will contain the following additional parameters:

referStatus: the sip status response to the REFER request
final_referred_call_status - the final sip status of the subsequent call to the transferee. This is only provided in the case where the REFER is accepted and NOTIFY requests are received from the far end.

eventHook properties

The eventHook webhook will contain two parameters: event and call_status. The event parameter will always be transfer-status and the call-status will contain a sip status received in a NOTIFY after a successful REFER; e.g.

1 {
2 	"event": "transfer-status",
3 	"call_status": "180"
4 }