Skip to main content
POST
/
sms
Send an outbound SMS from an agent's connected number
curl --request POST \
  --url https://eu-gcp-api.vg-stuff.com/v3/sms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentId": "<string>",
  "to": "<string>",
  "from": "<string>",
  "message": "<string>",
  "mediaUrl": "<string>",
  "mediaUrls": [
    "<string>"
  ],
  "mode": "direct",
  "campaignId": "<string>",
  "convoId": "<string>",
  "leadInfo": {
    "username": "<string>",
    "email": "<string>",
    "address": "<string>"
  },
  "options": {
    "dryRun": true,
    "createConvo": true,
    "persistToConvo": true,
    "skipIfHumanHandoff": true,
    "splitLongMessages": true,
    "sendViaEdge": true,
    "disableRecordHistory": true,
    "initialPrompt": "<string>",
    "statusCallbackUrl": "<string>",
    "messagingServiceSid": "<string>",
    "validityPeriod": 7200,
    "provideFeedback": true,
    "smartEncoded": true,
    "agentOptions": {
      "serverData": {
        "agentTools": "<array>",
        "agentVariables": "<array>",
        "agentOrg": "<unknown>",
        "agentClients": "<array>",
        "orgTeams": "<array>",
        "agentData": {
          "title": "<string>",
          "description": "<string>",
          "ownerID": "<string>",
          "theme": "<string>",
          "voiceConfig": {},
          "light": true,
          "enableVertex": true,
          "autoOpenWidget": true,
          "createdAtUNIX": 123,
          "disabled": true,
          "vectorDb": "<unknown>",
          "withRefresh": true,
          "agentPlatform": "<string>",
          "ID": "<string>",
          "storageID": "<string>",
          "VF_DIALOGUE_API_KEY": "<string>",
          "VF_PROJECT_API_KEY": "<string>",
          "VF_PROJECT_ID": "<string>",
          "VF_ENVIRONMENT_ALIAS": "<string>",
          "VF_KB_API_KEY": "<string>",
          "roundedImageURL": "<string>",
          "rectangeImageURL": "<string>",
          "messageDelayMS": 123,
          "scrollAnimation": true,
          "proactiveMessage": "<string>",
          "acceptFileUpload": true,
          "recordChatHistory": true,
          "chatBgURL": "<string>",
          "disableSmoothScroll": true,
          "isDeployed": true,
          "tokensUsage": "<unknown>",
          "maxTokensUsage": "<unknown>",
          "lastModified": 123,
          "fontFamily": "<string>",
          "branding": "<string>",
          "customThemeJSONString": "<string>",
          "autoStartWidget": true,
          "allTimeTriggers": 123,
          "syncBrowser": true,
          "delayBeforeSubmit": 123,
          "messageAggregationSeconds": 123,
          "listenForUrlChanges": true,
          "chatForget": true,
          "lang": "<string>",
          "enableAudioSupport": true,
          "AITranslateTo": "<string>",
          "enableAITranslate": true,
          "disableNoReplyListener": true,
          "disableHumanHandoff": true,
          "alwaysShowHandoff": true,
          "manualControl": true,
          "enableVGHandoff": true,
          "enableGeoAnalytics": true,
          "hideVoiceflowAnalytics": true,
          "hideCallAnalytics": true,
          "hideConversationMetrics": true,
          "hideCustomAnalytics": true,
          "hideVapiAnalytics": true,
          "hideFunnelAnalytics": true,
          "hideHandoffAnalytics": true,
          "fixedHandoffPopup": true,
          "ADVANCED_customCSS": "<string>",
          "messagesLimit": 123,
          "whatsappToken": "<string>",
          "whatsappNumberId": "<string>",
          "whatsappBusniessId": "<string>",
          "whatsappCustomBridge": {
            "enabled": true,
            "webhookUrl": "<string>",
            "forwardToDeveloper": true
          },
          "waTestNumber": "<string>",
          "waVerifyPassed": true,
          "waTestPassed": true,
          "twilioSmsAccountSid": "<string>",
          "twilioSmsAuthToken": "<string>",
          "twilioSmsPhoneNumber": "<string>",
          "twilioSmsVerified": true,
          "twilioSmsPhoneNumberSid": "<string>",
          "twilioSmsRentalSubscriptionId": "<string>",
          "webhookUrl": "<string>",
          "gcloudPrivateKey": "<string>",
          "gcloudClientEmail": "<string>",
          "smartInit": true,
          "UIhandoffTitle": "<string>",
          "UIhandoffSubtitle": "<string>",
          "igVerified": true,
          "igAccessToken": "<string>",
          "showHandoffEvenIfOffline": true,
          "persistHandoffOnRefresh": true,
          "enableBugReporting": true,
          "blockInputDuringHandoffRequest": true,
          "disableHandoffMessages": true,
          "disableHandoffStatusMessages": true,
          "customButtonJSON_STRING": "<string>",
          "vg_initPrompt": "<string>",
          "vg_prompt": "<string>",
          "vg_initMessages": [
            "<string>"
          ],
          "vg_systemPrompt": "<string>",
          "vg_temperature": 123,
          "vg_maxTokens": 123,
          "vg_kbDefaultDimension": 123,
          "vg_kbTopChunks": 123,
          "SECRET_API_KEY": "<string>",
          "vg_kbCharCount": 123,
          "vg_kbDocsNum": 123,
          "vg_enableUIEngine": true,
          "vg_enableAboutContext": true,
          "vg_kb_llm": {
            "searchPrompt": "<string>",
            "temprature": 123,
            "maxTokens": 123
          },
          "vg_enableUIEngineForms": true,
          "vg_max_messages_history": 123,
          "ifKnowsThreshold": 123,
          "avatarImageUrl": "<string>",
          "headerImageUrl": "<string>",
          "bannerImageUrl": "<string>",
          "soundEffectUrl": "<string>",
          "soundEffectEnabled": true,
          "enableQuickFileUpload": true,
          "instagramOptions": {
            "pageId": "<string>",
            "accessToken": "<string>"
          },
          "translateUserResponse": true,
          "starred": true,
          "flowise": {
            "webhookUrl": "<string>",
            "webhookSecret": "<string>"
          },
          "vfSettings": {
            "enableIgnoreUrlPaths": true
          },
          "vapi": "<unknown>",
          "vapiConfig": {
            "syncKbOnSave": true,
            "PUBLIC_API_KEY": "<string>",
            "PRIVATE_API_KEY": "<string>",
            "enableVapiOnWeb": true,
            "overrideWithVG": true,
            "promptOnWeb": true,
            "maxCostMonthly": 123,
            "maxMinutesMonthly": 123,
            "useVfProject": true,
            "syncTools": true
          },
          "vgOptions": {
            "isLlmStudio": true,
            "showSources": true,
            "lightUiEngine": true,
            "legacyKb": true,
            "maxChunkSize": 123,
            "handoffTimeout": 123
          },
          "ui": {
            "showWhatsappButtonOnWeb": true,
            "bgImageVisible": true,
            "enableFixedFeedbackBtns": true,
            "switchConversationSides": true,
            "switchDashboardOnly": true
          },
          "assignedToolsIds": [
            "<string>"
          ],
          "tools": [
            {
              "id": "<string>",
              "name": "<string>",
              "description": "<string>",
              "isDefault": true,
              "serverUrl": "<string>",
              "serverUrlSecret": "<string>",
              "createdAt": "<string>",
              "updatedAt": "<string>",
              "disabled": true,
              "isVapiTool": true,
              "vapiId": "<string>",
              "isGlobal": true,
              "variablesIds": [
                "<string>"
              ],
              "agentId": "<string>",
              "userId": "<string>",
              "backchannellingPhrases": [
                "<string>"
              ],
              "toolsSettings": "<unknown>",
              "fields": [
                {
                  "id": "<string>",
                  "in": "<string>",
                  "value": "<unknown>",
                  "defaultValue": "<unknown>",
                  "key": "<string>",
                  "description": "<string>",
                  "required": true,
                  "reusable": true,
                  "isEnv": true,
                  "isSystem": true,
                  "isGlobal": true,
                  "agentId": "<string>",
                  "userId": "<string>"
                }
              ],
              "channels": []
            }
          ],
          "internal": {
            "setOnResponse": true,
            "enableSetOnLoad": true
          },
          "disableAutoTranscribeAudio": true,
          "disableTranscriptSharing": true,
          "instaAgentUsername": "<string>",
          "convoTags": [
            "<string>"
          ],
          "vfConfig": {
            "alwaysEnableCardButtons": true
          },
          "discord": {
            "channelIds": [
              "<string>"
            ],
            "webhookUrls": [
              "<string>"
            ]
          },
          "limits": {
            "maxInteractionsPerUserId": 123,
            "enableTextIpRateLimit": true,
            "maxTextInteractionsPerIp": 123,
            "textIpRateLimitWindowHours": 123,
            "maxAnnualCreditsUsage": 123,
            "maxMonthlyCreditsUsage": 123,
            "maxMessages": 123,
            "maxMessagesRetentionDays": 123
          },
          "tabs": [
            {
              "label": "<string>",
              "iconUrl": "<string>",
              "iframeUrl": "<string>",
              "iframeHeight": 123,
              "hide": true
            }
          ],
          "kbTags": [
            "<string>"
          ],
          "kbTagsDataMap": "<array>",
          "nodes": [
            {
              "id": "<string>",
              "name": "<string>",
              "description": "<string>",
              "instructions": "<string>",
              "llmConfig": {
                "temperature": 123,
                "maxTokens": 123,
                "customModelId": "<string>",
                "serverUrl": "<string>",
                "apiKey": "<string>"
              },
              "language": "<string>",
              "mcpServers": [
                {
                  "name": "<string>",
                  "url": "<string>",
                  "useNodeEventSource": true,
                  "reconnect": {
                    "enabled": true,
                    "maxAttempts": 123,
                    "delayMs": 123
                  },
                  "command": "<string>",
                  "args": [
                    "<string>"
                  ],
                  "env": {},
                  "cwd": "<string>",
                  "headers": {}
                }
              ],
              "voiceInstructions": "<string>",
              "isGlobal": true,
              "toolsIds": [
                "<string>"
              ],
              "toolsSettings": {
                "googleCalendar": {
                  "calendarId": "<string>",
                  "methods": []
                },
                "googleSheets": {
                  "connectionId": "<string>",
                  "sheetId": "<string>",
                  "method": "<string>",
                  "sheetTabName": "<string>",
                  "headerRowIndex": 123,
                  "headerDescriptions": {},
                  "identifierColumn": "<string>",
                  "identityFields": {
                    "phone": "<string>",
                    "email": "<string>",
                    "name": "<string>",
                    "custom": "<string>",
                    "customLabel": "<string>"
                  },
                  "queryableFields": [
                    "<string>"
                  ]
                },
                "airtable": {
                  "connectionId": "<string>",
                  "baseId": "<string>",
                  "tableId": "<string>",
                  "method": "<string>",
                  "fieldDescriptions": {},
                  "identifierField": "<string>"
                }
              },
              "childrenNodes": [
                {
                  "nodeId": "<string>",
                  "condition": "<string>"
                }
              ],
              "toolUseBias": 123,
              "rf": "<unknown>",
              "preStart": {
                "url": "<string>",
                "enabled": true,
                "testConvoIdValue": "<string>"
              },
              "startConfig": {
                "initialMessage": "<string>",
                "userStarts": true,
                "inboundUserStarts": true,
                "outboundUserStarts": true
              }
            }
          ],
          "enableNodes": true,
          "advanced": {
            "serverUrl": "<string>",
            "serverUrlSecret": "<string>"
          },
          "nodesSettings": {
            "enableUIEngineForms": true,
            "geminiLiveOptions": "<unknown>",
            "appendBeforePrompt": "<string>",
            "backchannelOnChoosingNodes": true,
            "enableUiEngine": true,
            "fallbackModelIds": [],
            "silenceDetection": {
              "enabled": false,
              "timeoutSeconds": 60,
              "endCallAfterNPhrases": 1
            },
            "startCallPhrases": [
              "<string>"
            ],
            "fillerWordsOnToolUsage": true,
            "toolUsageBackchannelPhrasesByLanguage": {},
            "smartEndpointing": {
              "enabled": true,
              "waitSeconds": 123,
              "onPunctuationSeconds": 123,
              "onNoPunctuationSeconds": 123,
              "onNumberSeconds": 123
            },
            "stopSpeakPlan": {
              "minWords": 123
            },
            "callTimeoutSeconds": 123,
            "enableEndcallTool": true,
            "voiceSpecific": {
              "minCharacters": 123,
              "maxLengthWithoutPunctuation": 123
            },
            "enabledGlobalTools": [],
            "defaultToolOverrides": {}
          },
          "id": "<string>",
          "enableFallback": true,
          "fallbackSettings": {
            "creditThreshold": 123
          },
          "marketplace": {
            "enabled": true,
            "priceUSD": 123,
            "creatorDisplayName": "<string>",
            "shortDescription": "<string>",
            "documentation": "<string>",
            "toolsDocumentation": [
              {
                "name": "<string>",
                "description": "<string>",
                "codeUrl": "<string>",
                "docsUrl": "<string>",
                "setupInstructions": "<string>"
              }
            ],
            "tags": [
              "<string>"
            ],
            "screenshots": [
              "<string>"
            ],
            "demoUrl": "<string>",
            "videoUrl": "<string>",
            "version": "<string>",
            "changelog": "<string>",
            "supportEmail": "<string>",
            "listedAt": 123,
            "updatedAt": 123,
            "allowCanvasPreview": true,
            "allowTryAgent": true,
            "likeCount": 0,
            "downloadCount": 0
          },
          "disableRating": true,
          "chatEndMessage": "<string>",
          "aiIntroductionMessage": "<string>",
          "enableAIIntroductionMessage": true,
          "deployed": true,
          "captureIGStories": true,
          "gdprCompliance": true,
          "disableFileUpload": true,
          "privacyDisclaimer": {
            "enabled": true,
            "text": "<string>",
            "privacyPolicyUrl": "<string>",
            "acceptButtonLabel": "<string>",
            "privacyPolicyButtonLabel": "<string>"
          },
          "leadCollectionRules": {
            "enabled": true,
            "rules": [
              {
                "variables": [
                  "<string>"
                ],
                "description": "<string>"
              }
            ]
          },
          "identityResolutionSettings": {
            "enabled": true,
            "softMatchEnabled": true
          },
          "emailConfig": {
            "enabled": true,
            "assignedEmails": [
              {
                "connectionId": "<string>",
                "email": "<string>",
                "replyDelay": 0,
                "replyDelayMinutes": 0,
                "whenToReply": "always",
                "replyRule": "",
                "humanNotifyRule": "",
                "notifyWorkspaceOwners": true,
                "humanTakeoverEnabled": false,
                "humanTakeoverTimeoutMinutes": 0,
                "replyLength": "auto",
                "replyTone": "professional"
              }
            ]
          },
          "inboundEngagement": {
            "enabled": true,
            "channels": [],
            "aiRule": "<string>",
            "aiModelId": "<string>",
            "triggerPhrases": [
              "<string>"
            ],
            "availability": {
              "enabled": true,
              "timezone": "<string>",
              "days": [],
              "startTime": "<string>",
              "endTime": "<string>"
            },
            "participantList": [
              "<string>"
            ],
            "analyzeAttachmentsBeforeDecision": true,
            "enableHumanHandoffTool": true
          },
          "autoTest": {
            "enabled": true,
            "triggerOnEdit": true,
            "maxTurns": 123,
            "naturalEnd": true,
            "testScenario": "<string>",
            "enabledToolIds": [
              "<string>"
            ],
            "enableKB": true
          },
          "langsmithConfig": {
            "enabled": true,
            "apiKey": "<string>",
            "projectName": "<string>",
            "endpoint": "<string>"
          },
          "funnelConfig": {
            "enabled": false,
            "steps": [],
            "notificationRules": [],
            "maxScore": 100,
            "evaluateOnUserMessage": true,
            "evaluateOnAIMessage": true
          }
        },
        "workspaceData": "<unknown>",
        "twilioAccountSid": "<string>",
        "twilioAuthToken": "<string>",
        "assignedGlobalPrompts": [
          "<string>"
        ]
      },
      "overrideInitialPrompt": true,
      "messagesHistory": [
        {
          "content": "<string>",
          "name": "<string>",
          "timestamp": 123,
          "tool_call_id": "<string>",
          "tool_name": "<string>",
          "tool_calls": "<unknown>"
        }
      ],
      "agentOverrides": {
        "title": "<string>",
        "description": "<string>",
        "theme": "<string>",
        "voiceConfig": {},
        "light": true,
        "enableVertex": true,
        "autoOpenWidget": true,
        "createdAtUNIX": 123,
        "disabled": true,
        "vectorDb": "<unknown>",
        "agentPlatform": "<string>",
        "storageID": "<string>",
        "VF_DIALOGUE_API_KEY": "<string>",
        "VF_PROJECT_API_KEY": "<string>",
        "VF_PROJECT_ID": "<string>",
        "VF_ENVIRONMENT_ALIAS": "<string>",
        "VF_KB_API_KEY": "<string>",
        "roundedImageURL": "<string>",
        "rectangeImageURL": "<string>",
        "messageDelayMS": 123,
        "scrollAnimation": true,
        "proactiveMessage": "<string>",
        "acceptFileUpload": true,
        "recordChatHistory": true,
        "chatBgURL": "<string>",
        "disableSmoothScroll": true,
        "isDeployed": true,
        "tokensUsage": "<unknown>",
        "maxTokensUsage": "<unknown>",
        "fontFamily": "<string>",
        "branding": "<string>",
        "customThemeJSONString": "<string>",
        "autoStartWidget": true,
        "allTimeTriggers": 123,
        "syncBrowser": true,
        "delayBeforeSubmit": 123,
        "messageAggregationSeconds": 123,
        "listenForUrlChanges": true,
        "chatForget": true,
        "lang": "<string>",
        "enableAudioSupport": true,
        "AITranslateTo": "<string>",
        "enableAITranslate": true,
        "disableNoReplyListener": true,
        "disableHumanHandoff": true,
        "alwaysShowHandoff": true,
        "manualControl": true,
        "enableVGHandoff": true,
        "enableGeoAnalytics": true,
        "hideVoiceflowAnalytics": true,
        "hideCallAnalytics": true,
        "hideConversationMetrics": true,
        "hideCustomAnalytics": true,
        "hideVapiAnalytics": true,
        "hideFunnelAnalytics": true,
        "hideHandoffAnalytics": true,
        "fixedHandoffPopup": true,
        "ADVANCED_customCSS": "<string>",
        "messagesLimit": 123,
        "whatsappToken": "<string>",
        "whatsappNumberId": "<string>",
        "whatsappBusniessId": "<string>",
        "whatsappCustomBridge": {
          "enabled": true,
          "webhookUrl": "<string>",
          "forwardToDeveloper": true
        },
        "waTestNumber": "<string>",
        "waVerifyPassed": true,
        "waTestPassed": true,
        "twilioSmsAccountSid": "<string>",
        "twilioSmsAuthToken": "<string>",
        "twilioSmsPhoneNumber": "<string>",
        "twilioSmsVerified": true,
        "twilioSmsPhoneNumberSid": "<string>",
        "twilioSmsRentalSubscriptionId": "<string>",
        "webhookUrl": "<string>",
        "gcloudPrivateKey": "<string>",
        "gcloudClientEmail": "<string>",
        "smartInit": true,
        "UIhandoffTitle": "<string>",
        "UIhandoffSubtitle": "<string>",
        "igVerified": true,
        "igAccessToken": "<string>",
        "showHandoffEvenIfOffline": true,
        "persistHandoffOnRefresh": true,
        "enableBugReporting": true,
        "blockInputDuringHandoffRequest": true,
        "disableHandoffMessages": true,
        "disableHandoffStatusMessages": true,
        "customButtonJSON_STRING": "<string>",
        "vg_initPrompt": "<string>",
        "vg_prompt": "<string>",
        "vg_initMessages": [
          "<string>"
        ],
        "vg_systemPrompt": "<string>",
        "vg_temperature": 123,
        "vg_maxTokens": 123,
        "vg_kbDefaultDimension": 123,
        "vg_kbTopChunks": 123,
        "SECRET_API_KEY": "<string>",
        "vg_kbCharCount": 123,
        "vg_kbDocsNum": 123,
        "vg_enableUIEngine": true,
        "vg_enableAboutContext": true,
        "vg_kb_llm": {
          "searchPrompt": "<string>",
          "temprature": 123,
          "maxTokens": 123
        },
        "vg_enableUIEngineForms": true,
        "vg_max_messages_history": 123,
        "ifKnowsThreshold": 123,
        "avatarImageUrl": "<string>",
        "headerImageUrl": "<string>",
        "bannerImageUrl": "<string>",
        "soundEffectUrl": "<string>",
        "soundEffectEnabled": true,
        "enableQuickFileUpload": true,
        "instagramOptions": {
          "pageId": "<string>",
          "accessToken": "<string>"
        },
        "translateUserResponse": true,
        "starred": true,
        "flowise": {
          "webhookUrl": "<string>",
          "webhookSecret": "<string>"
        },
        "vfSettings": {
          "enableIgnoreUrlPaths": true
        },
        "vapiConfig": {
          "syncKbOnSave": true,
          "PUBLIC_API_KEY": "<string>",
          "PRIVATE_API_KEY": "<string>",
          "enableVapiOnWeb": true,
          "overrideWithVG": true,
          "promptOnWeb": true,
          "maxCostMonthly": 123,
          "maxMinutesMonthly": 123,
          "useVfProject": true,
          "syncTools": true
        },
        "vgOptions": {
          "isLlmStudio": true,
          "showSources": true,
          "lightUiEngine": true,
          "legacyKb": true,
          "maxChunkSize": 123,
          "handoffTimeout": 123
        },
        "ui": {
          "showWhatsappButtonOnWeb": true,
          "bgImageVisible": true,
          "enableFixedFeedbackBtns": true,
          "switchConversationSides": true,
          "switchDashboardOnly": true
        },
        "assignedToolsIds": [
          "<string>"
        ],
        "tools": [
          {
            "id": "<string>",
            "name": "<string>",
            "description": "<string>",
            "isDefault": true,
            "serverUrl": "<string>",
            "serverUrlSecret": "<string>",
            "createdAt": "<string>",
            "updatedAt": "<string>",
            "disabled": true,
            "isVapiTool": true,
            "vapiId": "<string>",
            "isGlobal": true,
            "variablesIds": [
              "<string>"
            ],
            "agentId": "<string>",
            "userId": "<string>",
            "backchannellingPhrases": [
              "<string>"
            ],
            "toolsSettings": "<unknown>",
            "fields": [
              {
                "id": "<string>",
                "in": "<string>",
                "value": "<unknown>",
                "defaultValue": "<unknown>",
                "key": "<string>",
                "description": "<string>",
                "required": true,
                "reusable": true,
                "isEnv": true,
                "isSystem": true,
                "isGlobal": true,
                "agentId": "<string>",
                "userId": "<string>"
              }
            ],
            "channels": []
          }
        ],
        "internal": {
          "setOnResponse": true,
          "enableSetOnLoad": true
        },
        "disableAutoTranscribeAudio": true,
        "disableTranscriptSharing": true,
        "instaAgentUsername": "<string>",
        "convoTags": [
          "<string>"
        ],
        "vfConfig": {
          "alwaysEnableCardButtons": true
        },
        "discord": {
          "channelIds": [
            "<string>"
          ],
          "webhookUrls": [
            "<string>"
          ]
        },
        "limits": {
          "maxInteractionsPerUserId": 123,
          "enableTextIpRateLimit": true,
          "maxTextInteractionsPerIp": 123,
          "textIpRateLimitWindowHours": 123,
          "maxAnnualCreditsUsage": 123,
          "maxMonthlyCreditsUsage": 123,
          "maxMessages": 123,
          "maxMessagesRetentionDays": 123
        },
        "tabs": [
          {
            "label": "<string>",
            "iconUrl": "<string>",
            "iframeUrl": "<string>",
            "iframeHeight": 123,
            "hide": true
          }
        ],
        "kbTags": [
          "<string>"
        ],
        "kbTagsDataMap": "<array>",
        "nodes": [
          {
            "id": "<string>",
            "name": "<string>",
            "description": "<string>",
            "instructions": "<string>",
            "llmConfig": {
              "temperature": 123,
              "maxTokens": 123,
              "customModelId": "<string>",
              "serverUrl": "<string>",
              "apiKey": "<string>"
            },
            "language": "<string>",
            "mcpServers": [
              {
                "name": "<string>",
                "url": "<string>",
                "useNodeEventSource": true,
                "reconnect": {
                  "enabled": true,
                  "maxAttempts": 123,
                  "delayMs": 123
                },
                "command": "<string>",
                "args": [
                  "<string>"
                ],
                "env": {},
                "cwd": "<string>",
                "headers": {}
              }
            ],
            "voiceInstructions": "<string>",
            "isGlobal": true,
            "toolsIds": [
              "<string>"
            ],
            "toolsSettings": {
              "googleCalendar": {
                "calendarId": "<string>",
                "methods": []
              },
              "googleSheets": {
                "connectionId": "<string>",
                "sheetId": "<string>",
                "method": "<string>",
                "sheetTabName": "<string>",
                "headerRowIndex": 123,
                "headerDescriptions": {},
                "identifierColumn": "<string>",
                "identityFields": {
                  "phone": "<string>",
                  "email": "<string>",
                  "name": "<string>",
                  "custom": "<string>",
                  "customLabel": "<string>"
                },
                "queryableFields": [
                  "<string>"
                ]
              },
              "airtable": {
                "connectionId": "<string>",
                "baseId": "<string>",
                "tableId": "<string>",
                "method": "<string>",
                "fieldDescriptions": {},
                "identifierField": "<string>"
              }
            },
            "childrenNodes": [
              {
                "nodeId": "<string>",
                "condition": "<string>"
              }
            ],
            "toolUseBias": 123,
            "rf": "<unknown>",
            "preStart": {
              "url": "<string>",
              "enabled": true,
              "testConvoIdValue": "<string>"
            },
            "startConfig": {
              "initialMessage": "<string>",
              "userStarts": true,
              "inboundUserStarts": true,
              "outboundUserStarts": true
            }
          }
        ],
        "enableNodes": true,
        "advanced": {
          "serverUrl": "<string>",
          "serverUrlSecret": "<string>"
        },
        "nodesSettings": {
          "enableUIEngineForms": true,
          "geminiLiveOptions": "<unknown>",
          "appendBeforePrompt": "<string>",
          "backchannelOnChoosingNodes": true,
          "enableUiEngine": true,
          "fallbackModelIds": [],
          "silenceDetection": {
            "enabled": false,
            "timeoutSeconds": 60,
            "endCallAfterNPhrases": 1
          },
          "startCallPhrases": [
            "<string>"
          ],
          "fillerWordsOnToolUsage": true,
          "toolUsageBackchannelPhrasesByLanguage": {},
          "smartEndpointing": {
            "enabled": true,
            "waitSeconds": 123,
            "onPunctuationSeconds": 123,
            "onNoPunctuationSeconds": 123,
            "onNumberSeconds": 123
          },
          "stopSpeakPlan": {
            "minWords": 123
          },
          "callTimeoutSeconds": 123,
          "enableEndcallTool": true,
          "voiceSpecific": {
            "minCharacters": 123,
            "maxLengthWithoutPunctuation": 123
          },
          "enabledGlobalTools": [],
          "defaultToolOverrides": {}
        },
        "enableFallback": true,
        "fallbackSettings": {
          "creditThreshold": 123
        },
        "marketplace": {
          "enabled": true,
          "priceUSD": 123,
          "creatorDisplayName": "<string>",
          "shortDescription": "<string>",
          "documentation": "<string>",
          "toolsDocumentation": [
            {
              "name": "<string>",
              "description": "<string>",
              "codeUrl": "<string>",
              "docsUrl": "<string>",
              "setupInstructions": "<string>"
            }
          ],
          "tags": [
            "<string>"
          ],
          "screenshots": [
            "<string>"
          ],
          "demoUrl": "<string>",
          "videoUrl": "<string>",
          "version": "<string>",
          "changelog": "<string>",
          "supportEmail": "<string>",
          "listedAt": 123,
          "updatedAt": 123,
          "allowCanvasPreview": true,
          "allowTryAgent": true,
          "likeCount": 0,
          "downloadCount": 0
        },
        "disableRating": true,
        "chatEndMessage": "<string>",
        "aiIntroductionMessage": "<string>",
        "enableAIIntroductionMessage": true,
        "deployed": true,
        "captureIGStories": true,
        "gdprCompliance": true,
        "disableFileUpload": true,
        "privacyDisclaimer": {
          "enabled": true,
          "text": "<string>",
          "privacyPolicyUrl": "<string>",
          "acceptButtonLabel": "<string>",
          "privacyPolicyButtonLabel": "<string>"
        },
        "leadCollectionRules": {
          "enabled": true,
          "rules": [
            {
              "variables": [
                "<string>"
              ],
              "description": "<string>"
            }
          ]
        },
        "identityResolutionSettings": {
          "enabled": true,
          "softMatchEnabled": true
        },
        "emailConfig": {
          "enabled": true,
          "assignedEmails": [
            {
              "connectionId": "<string>",
              "email": "<string>",
              "replyDelay": 0,
              "replyDelayMinutes": 0,
              "whenToReply": "always",
              "replyRule": "",
              "humanNotifyRule": "",
              "notifyWorkspaceOwners": true,
              "humanTakeoverEnabled": false,
              "humanTakeoverTimeoutMinutes": 0,
              "replyLength": "auto",
              "replyTone": "professional"
            }
          ]
        },
        "inboundEngagement": {
          "enabled": true,
          "channels": [],
          "aiRule": "<string>",
          "aiModelId": "<string>",
          "triggerPhrases": [
            "<string>"
          ],
          "availability": {
            "enabled": true,
            "timezone": "<string>",
            "days": [],
            "startTime": "<string>",
            "endTime": "<string>"
          },
          "participantList": [
            "<string>"
          ],
          "analyzeAttachmentsBeforeDecision": true,
          "enableHumanHandoffTool": true
        },
        "autoTest": {
          "enabled": true,
          "triggerOnEdit": true,
          "maxTurns": 123,
          "naturalEnd": true,
          "testScenario": "<string>",
          "enabledToolIds": [
            "<string>"
          ],
          "enableKB": true
        },
        "langsmithConfig": {
          "enabled": true,
          "apiKey": "<string>",
          "projectName": "<string>",
          "endpoint": "<string>"
        },
        "funnelConfig": {
          "enabled": false,
          "steps": [],
          "notificationRules": [],
          "maxScore": 100,
          "evaluateOnUserMessage": true,
          "evaluateOnAIMessage": true
        }
      },
      "toolsOverrides": [
        {
          "name": "<string>",
          "description": "<string>",
          "isDefault": true,
          "serverUrl": "<string>",
          "serverUrlSecret": "<string>",
          "disabled": true,
          "isVapiTool": true,
          "vapiId": "<string>",
          "isGlobal": true,
          "backchannellingPhrases": [
            "<string>"
          ],
          "toolsSettings": "<unknown>",
          "fields": [
            {
              "id": "<string>",
              "in": "<string>",
              "value": "<unknown>",
              "defaultValue": "<unknown>",
              "key": "<string>",
              "description": "<string>",
              "required": true,
              "reusable": true,
              "isEnv": true,
              "isSystem": true,
              "isGlobal": true,
              "agentId": "<string>",
              "userId": "<string>"
            }
          ],
          "channels": []
        }
      ],
      "variablesOverrides": [
        {
          "in": "<string>",
          "value": "<unknown>",
          "defaultValue": "<unknown>",
          "key": "<string>",
          "description": "<string>",
          "required": true,
          "reusable": true,
          "isEnv": true,
          "isSystem": true,
          "isGlobal": true
        }
      ],
      "callerInfo": "<unknown>",
      "callInfo": "<unknown>",
      "currentNode": "<string>",
      "awaitListenUrl": true
    }
  }
}
'
{
  "success": true,
  "status": "<string>",
  "dryRun": true,
  "skipped": true,
  "reason": "<string>",
  "agentId": "<string>",
  "to": "<string>",
  "from": "<string>",
  "convoId": "<string>",
  "campaignId": "<string>",
  "messageSid": "<string>",
  "messageSids": [
    "<string>"
  ],
  "messageCount": 123,
  "mediaCount": 123,
  "messagesPreview": [
    "<string>"
  ],
  "segments": [
    {
      "messageSid": "<string>",
      "segmentIndex": 123,
      "status": "<string>"
    }
  ]
}

​
Example — direct send

{
  "agentId": "your-agent-id",
  "to": "+15551234567",
  "message": "Hi Jane — following up on your appointment.",
  "campaignId": "campaign-123",
  "leadInfo": {
    "username": "Jane",
    "email": "jane@example.com"
  }
}

​
Example — AI-generated opener (mode: agent)

{
  "agentId": "your-agent-id",
  "to": "+15551234567",
  "mode": "agent",
  "leadInfo": { "username": "Jane", "company": "Acme Corp" },
  "options": {
    "initialPrompt": "Write a short friendly SMS to remind them about tomorrow's appointment.",
    "sendViaEdge": true
  }
}
to and optional from must be E.164 (+ and country code). The agent must have an SMS-capable Twilio number connected (own account or platform rental).
Use options.dryRun: true to validate routing (from number, mode, segment count) without sending.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
agentId
string
required

Agent ID whose connected SMS number will send the message.

Minimum string length: 1
​
to
string
required

Recipient phone number in E.164 format, e.g. +15551234567.

Pattern: ^\+
​
from
string

Specific connected Twilio number to send from. Defaults to the agent's primary SMS number.

Pattern: ^\+
​
message
string

Message body for direct mode. Required unless mode is agent and initialPrompt is provided via options.

​
mediaUrl
string<uri>

Single MMS media URL.

​
mediaUrls
string<uri>[]

Multiple MMS media URLs (Twilio supports up to 10).

Maximum array length: 10
​
mode
enum<string>
default:direct

direct = send the message as-is. agent = run the agent first and send its generated reply.

Available options:
direct,
agent
​
campaignId
string

Optional campaign ID to attach to the outbound SMS conversation.

​
convoId
string

Custom conversation ID. Defaults to the normalized recipient phone number digits.

​
leadInfo
object

Lead metadata merged into the conversation for personalization.

​
options
object

Advanced options for outbound SMS delivery and conversation handling.

Response

Successful response

​
success
boolean
required
​
status
string
​
dryRun
boolean
​
skipped
boolean
​
reason
string
​
agentId
string
​
to
string
​
from
string
​
convoId
string
​
mode
enum<string>
Available options:
direct,
agent
​
senderMode
enum<string>
Available options:
own_account,
platform_rental
​
campaignId
string
​
messageSid
string
​
messageSids
string[]
​
messageCount
number
​
mediaCount
number
​
messagesPreview
string[]
​
segments
object[]