sip_refer

Send SIP REFER to a SIP call.

Name	Type	Default	Description
sip_refer Required	object	-	An object that accepts the sip_refer parameters.

sip_refer Parameters

Name	Type	Description
to_uri Required	string	SIP URI to REFER to.

Variables

Set by the method:

• sip_refer_to: (out) The SIP URI the recipient is to INVITE.
• sip_refer_result: (out) Overall SIP REFER result.
• return_value: (out) Same value as sip_refer_result.
• sip_refer_response_code: (out) Recipient response to the REFER request.
• sip_refer_to_response_code: (out) INVITE response to the recipient.

Examples

Send SIP REFER and post result

YAML

version: 1.0.0
sections:
  main:
    - sip_refer:
        to_uri: 'sip:alice@example.com'
    - play:
        url: 'say: Connected. The SIP refer result is %{sip_refer_result}'
    - execute:
        dest: 'https://example.com/handle_sip_refer_result'

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "sip_refer": {
          "to_uri": "sip:alice@example.com"
        }
      },
      {
        "play": {
          "url": "say: Connected. The SIP refer result is %{sip_refer_result}"
        }
      },
      {
        "execute": {
          "dest": "https://example.com/handle_sip_refer_result"
        }
      }
    ]
  }
}