POST
/
v1
/
orgs
/
{org_id}
/
workspaces
/
{workspace_id}
/
outbounds
Initiate Outbound Api
curl --request POST \
  --url https://apps.sarvam.ai/api/outbounds/v1/orgs/{org_id}/workspaces/{workspace_id}/outbounds \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "app_config": {
    "app_id": "<string>",
    "app_version": 2,
    "connection_config": {
      "connection_id": "<string>",
      "agent_phone_number": "<string>"
    },
    "agent_variables": {},
    "app_type": "agent",
    "app_overrides": {
      "initial_bot_message": "<string>",
      "initial_state_name": "<string>",
      "initial_language_name": "Bengali"
    }
  },
  "user_config": {
    "user_phone_number": "<string>"
  },
  "webhook_config": {
    "url": "<string>",
    "metadata": {}
  }
}'
{
  "attempt_id": "<string>"
}

Authorizations

X-API-Key
string
header
required

Path Parameters

org_id
string
required
workspace_id
string
required

Body

application/json
app_config
object
required
user_config
object
required
webhook_config
object | null

Response

Successful Response

attempt_id
string
required