Add or Update Agent's Connection Config

Staging Env

https://staging-api.formi.co.in

POST

/v2/voice/connection_configuration/agents/{agent_id}/connection_config

Last modified:2025-07-12 12:42:23

Maintainer:Not configured

Adds or updates the specific credentials/parameters for an agent to use a certain provider. The request body must conform to the 'params' JSON schema defined by the vendor.

Request

Path Params

Query Params

Body Params application/json

Example

{
    "app_id": "string",
    "channels": 1,
    "encoding": "base64_pcm",
    "caller_id": "string",
    "account_sid": "string",
    "sample_rate": 8000,
    "ping_interval": 20,
    "exotel_password": "string",
    "exotel_username": "string",
    "chunk_size_bytes": 3200,
    "connection_timeout": 30
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://staging-api.formi.co.in/v2/voice/connection_configuration/agents//connection_config?connection_provider' \
--header 'Content-Type: application/json' \
--data-raw '{
    "app_id": "string",
    "channels": 1,
    "encoding": "base64_pcm",
    "caller_id": "string",
    "account_sid": "string",
    "sample_rate": 8000,
    "ping_interval": 20,
    "exotel_password": "string",
    "exotel_username": "string",
    "chunk_size_bytes": 3200,
    "connection_timeout": 30
}'

Responses

🟢200OK

application/json

Agent connection configuration added successfully.

Body

Example

{
    "status": "success",
    "message": "Operation was successful.",
    "payload": null
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Modified at 2025-07-12 12:42:23

Get Agent's Connection Config

Post Interaction Configuration