transfer

Transfer the execution of the script to a new URL.

Parameters

Name	Type	Description
dest	string	Specifies where to transfer to. Required. The value can be one of: "relay:<relay application>" - relay application to notify (currently not implemented) "https://<URL>" - URL to fetch next document from. Sends HTTP POST
params	object	Named parameters to send to a section, URL, or application. Optional. Default is not set.
meta	object	User data, ignored by SignalWire. Optional. Default is not set.

Variables

• return_value: (out) - Value returned by subroutine.

Examples

Named parameter

YAML

version: 1.0.0
sections:
  main:
    - transfer:
        dest: "https://example.com/next"

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "transfer": {
          "dest": "https://example.com/next"
        }
      }
    ]
  }
}

Named parameter with sub-parameters

YAML

version: 1.0.0
sections:
  main:
    - transfer:
        - dest: "https://example.com/next"
        - params:
            - foo: "bar"

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "transfer": {
          "dest": "https://example.com/next",
          "params": {
            "foo": "bar"
          }
        }
      }
    ]
  }
}

Implicit first parameter

YAML

version: 1.0.0
sections:
  main:
    - transfer: "https://example.com/next"

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "transfer": "https://example.com/next"
      }
    ]
  }
}