Call Control

Make a call

Places an outbound call through the configured provider, connecting a subscriber to a specified external number. Use this endpoint to programmatically trigger calls from applications or services.

Call Flow

Most providers follow a two-step process:

  1. Ring the subscriber's device
  2. Once answered, dial the external number and bridge the call

Some providers may support direct dialing, placing the call directly to the remote number using the subscriber's ID as the caller ID.

Usage Notes

  • Phone numbers must contain digits only (no dashes, spaces, or parentheses).
  • The subscriber must be registered and active with the provider.
  • Behavior may vary based on provider rules (e.g. number formats, identity handling).
  • Call success depends on provider connectivity and subscriber availability.
POST/v1/accounts/:accountID/applications/:applicationID/providers/:providerID/calls
Click to copy
curl --request POST \
  --url http://api.voistrix.com/v1/accounts/:accountID/applications/:applicationID/providers/:providerID/calls \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"providerSubscriberExtension":"string","providerSubscriberID":"string","providerSubscriberNumber":"string","remoteNumber":"string"}'

Path Parameters

  • :accountID - REQUIRED[String]

    The referenced account ID.

  • :applicationID - REQUIRED[String]

    The referenced application ID.

  • :providerID - REQUIRED[String]

    The referenced provider ID.

Make Call Request - [Map]

Request parameters for initiating an outbound call.

Attributes

  • providerSubscriberExtension - OPTIONAL[String]

    Extension number for the subscriber initiating the call.

  • providerSubscriberID - REQUIRED[String]

    Unique identifier for the subscriber initiating the call.

  • providerSubscriberNumber - OPTIONAL[String]

    Phone number of the subscriber initiating the call.

  • remoteNumber - REQUIRED[String]

    Destination phone number to be called.

Make Call Request Shape
Click to copy
{
  "providerSubscriberExtension": "string",
  "providerSubscriberID": "string",
  "providerSubscriberNumber": "string",
  "remoteNumber": "string"
}

Response

Indicates the request was successful. Returns a status code of 204 with no content returned in the response body.

Errors

A common set of Error Responses can be found here.