Create a New Connection Vendor

Staging Env

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

POST

/v2/voice/connection_configuration/vendors

Last modified:2025-07-12 11:50:25

Maintainer:Not configured

Creates a new vendor and defines the JSON schema for its required parameters.

Request

Body Params application/json

Example

{
    "vendor_name": "Twilio SMS",
    "description": "For sending SMS messages via Twilio.",
    "params": {
        "type": "object",
        "properties": {
            "account_sid": {
                "type": "string"
            },
            "auth_token": {
                "type": "string"
            }
        },
        "required": [
            "account_sid",
            "auth_token"
        ]
    }
}

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/vendors' \
--header 'Content-Type: application/json' \
--data-raw '{
    "vendor_name": "Twilio SMS",
    "description": "For sending SMS messages via Twilio.",
    "params": {
        "type": "object",
        "properties": {
            "account_sid": {
                "type": "string"
            },
            "auth_token": {
                "type": "string"
            }
        },
        "required": [
            "account_sid",
            "auth_token"
        ]
    }
}'

Responses

🟢200OK

application/json

Connection vendor created successfully.

Body

Example

{
    "status": "success",
    "message": "Connection vendor created successfully",
    "payload": {
        "vendor_id": 1,
        "vendor_name": "Twilio SMS",
        "description": "For sending SMS messages via Twilio.",
        "params": {}
    }
}

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Modified at 2025-07-12 11:50:25

Formi WebSocket Configuration Guide

Get All Connection Vendors