POST
/
rest
/
v2
/
call
/
phone
curl --request POST \
  --url https://api.outrival.com/rest/v2/call/phone \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "workflowId": "<string>",
  "deploymentId": "<string>",
  "phoneNumber": "<string>",
  "userName": "<string>",
  "userId": "<string>",
  "variables": {},
  "metadata": {},
  "externalId": "<string>",
  "anonymousId": "<string>"
}'
{
  "id": "<string>"
}

Authorizations

X-API-Key
string
header
required

Body

application/json
phoneNumber
string
required
metadata
object
required

Metadata

workflowId
string
deploymentId
string
userName
string
userId
string
variables
object
externalId
string
anonymousId
string

Response

200
application/json
Initiate phone call.
id
string
required