Forward a call

Forward a call to another phone number or to a SIP URI. This command will create a new call resource and both calls will be connected (bridged).

Command bridge new call with existing call

Check below the forward call object's properties.

type: object
title: Bridge new call with existing call
additionalProperties: false
properties:
  from:
    type: string
  to:
    type: string
  ringTimeout:
    type: integer
    minimum: 3
    maximum: 120
    default: 30
  maxDuration:
    type: integer
    minimum: 1
    default: 28800
  ringTone:
    $ref: '../properties/RingTone.yml'
  hangupAfterBridge:
    type: boolean
  record:
    type: boolean
  recordStart:
    type: string
    enum:
      - record-from-answer
      - record-from-ringing
  recordStereo:
    type: boolean
  notification:
    $ref: '../properties/Notification.yml'
required:
  - to

Forward call

post

Creates a new channel call and forward to it

Authorizations

useraccessKey

Path parameters

workspaceIdstring · uuidRequired

The ID of the workspace

callIdstring · uuidRequired

The ID for a call

channelIdstring · uuidRequired

The ID for a channel

Body

fromstringOptional

tostringRequired

ringTimeoutinteger · min: 3 · max: 120OptionalDefault: 30

maxDurationinteger · min: 1OptionalDefault: 28800

ringTonestring · enum | nullableOptionalPossible values:

hangupAfterBridgebooleanOptional

recordbooleanOptional

recordStartstring · enumOptionalPossible values:

recordStereobooleanOptional

Responses

202

Call Command Bridge was accepted for processing

application/json

400

The request did not pass validation

application/json

404

The request did not pass validation

application/json

422

The request did not pass validation

application/json

post

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/bridge HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 503

{
  "from": "text",
  "to": "text",
  "ringTimeout": 1,
  "maxDuration": 1,
  "ringTone": "be",
  "hangupAfterBridge": true,
  "record": true,
  "recordStart": "record-from-answer",
  "recordStereo": true,
  "callFlow": [
    {
      "command": "hangup",
      "conditions": [
        {
          "variable": "keys",
          "operator": "eq",
          "value": "text"
        }
      ],
      "options": {
        "media": [
          "text"
        ],
        "loop": 1,
        "timeout": 1,
        "pauseMilliseconds": 1
      }
    }
  ],
  "notification": {
    "url": "text"
  },
  "amdSettings": {
    "enabled": true,
    "wordCount": 1,
    "speechTimeout": 1,
    "speechLocale": "en-US",
    "beepTimeout": 1,
    "ifMachineNotifyAfter": "beep"
  }
}

{
  "command": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "callId": "123e4567-e89b-12d3-a456-426614174000",
    "callFlowId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "text",
    "command": "text",
    "conditions": [
      {
        "variable": "keys",
        "operator": "eq",
        "value": "text"
      }
    ]
  },
  "bridgedCall": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "channelId": "123e4567-e89b-12d3-a456-426614174000",
    "from": "text",
    "to": "text",
    "originator": {
      "contact": {
        "id": "text",
        "identifierKey": "text",
        "identifierValue": "text"
      },
      "number": {
        "type": "pstn",
        "number": "text",
        "anonymous": true,
        "callerIdName": "text",
        "identity": "text",
        "countryIsoCode": "text",
        "pstnNumberType": "text"
      }
    },
    "receiver": {
      "contact": {
        "id": "text",
        "identifierKey": "text",
        "identifierValue": "text"
      },
      "number": {
        "type": "pstn",
        "number": "text",
        "anonymous": true,
        "callerIdName": "text",
        "identity": "text",
        "countryIsoCode": "text",
        "pstnNumberType": "text"
      }
    },
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "direction": "incoming",
    "status": "accepted",
    "reason": "text",
    "type": "pstn",
    "duration": 1,
    "hangupCauseCode": 1,
    "hangupSource": "callee",
    "hangupSipCode": "text",
    "createdAt": "2025-05-09T04:50:36.531Z",
    "updatedAt": "2025-05-09T04:50:36.531Z",
    "ringingAt": "2025-05-09T04:50:36.531Z",
    "answeredAt": "2025-05-09T04:50:36.531Z",
    "endedAt": "2025-05-09T04:50:36.531Z",
    "scheduledFor": "2025-05-09T04:50:36.531Z",
    "callFlow": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "commands": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "callId": "123e4567-e89b-12d3-a456-426614174000",
          "callFlowId": "123e4567-e89b-12d3-a456-426614174000",
          "status": "text",
          "command": "text",
          "conditions": [
            {
              "variable": "keys",
              "operator": "eq",
              "value": "text"
            }
          ]
        }
      ]
    },
    "notification": {
      "url": "text"
    },
    "qualityInsights": {
      "mos": "text",
      "pdd": "text"
    },
    "sipInsights": {
      "hangupSipCode": "text",
      "edgeRegion": "text",
      "providerName": "text",
      "userAgent": "text",
      "remoteSignallingIp": "text",
      "remoteMediaIp": "text"
    },
    "amdResult": {
      "result": "human",
      "speech": "text",
      "locale": "text"
    },
    "sipType": "elastic",
    "tags": [
      "text"
    ]
  }
}

Example 1: Forward an inbound call to an external number

Request Headers

curl -X POST "https://nest.messagebird.one/workspaces/8bc02f53-87ac-48d2-b4fd-c2cf856a305f/channels/880d8171-cbab-47bb-81b6-b1a0902da136/calls/4fc2edf7-68f5-437a-89eb-3ce0095409d6
/bridge" \
     -H 'Authorization: Bearer {Token}'

Request Body

{​
  "from": "string",​
  "to": "string",​
  "ringTimeout": 30,​
  "maxDuration": 28800,​
  "record": true,​
  "recordStart": "record-from-answer",​
  "recordStereo": true​
​}

Response

{
  "command": {
    "id": "5982f9a9-759f-48fb-b335-d3ab879f43b5",
    "callId": "ea765a11-8cbb-45ac-80d8-f82b931af964",
    "command": "bridge",
    "status": "accepted"
  },
  "bridgedCall": {
    "id": "e76ab303-f303-49c7-9cc9-64603b3d6a49",
    "channelId": "db53c357-92e3-4f3d-babe-159573940a50",
    "originator": {
      "number": {
        "type": "pstn",
        "number": "[phone]",
        "countryIsoCode": "NL"
      }
    },
    "receiver": {
      "contact": {
        "id": "77571b0f-9b6e-4b5a-a54c-31067e72f989",
        "identifierKey": "phonenumber",
        "identifierValue": "[phone]"
      },
      "number": {
        "type": "pstn",
        "number": "[phone]",
        "countryIsoCode": "PT"
      }
    },
    "from": "[phone]",
    "to": "[phone]",
    "parentId": "ea765a11-8cbb-45ac-80d8-f82b931af964",
    "direction": "outgoing",
    "status": "accepted",
    "type": "pstn",
    "duration": 0,
    "notification": {},
    "createdAt": "2024-03-04T11:19:25.852Z",
    "updatedAt": "2024-03-04T11:19:25.852Z"
  }
}