{"openapi":"3.1.0","info":{"title":"Fast2SMS (BYOK) API","version":"0.1.0","description":"Fast2SMS (BYOK) lets an AI assistant read your own Fast2SMS data through the Fast2SMS API with a key you supply (Fast2SMS API authorization key). Read-only: 8 tools (get_wallet_balance, get_sms_summary, list_dlt_sender_ids, get_whatsapp_overview, list_whatsapp_phone_numbers, get_whatsapp_phone_number, get_whatsapp_business_profile, get_whatsapp_health_status). The BYOK key travels with each...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-fast2sms.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-fast2sms/docs"},"termsOfService":"https://connectorbay.com/byok-fast2sms/terms"},"servers":[{"url":"https://byok-fast2sms.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-fast2sms/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_wallet_balance":{"post":{"operationId":"get_wallet_balance","summary":"Show the Fast2SMS wallet balance (rupees) and the number of SMS the balance covers. Use for \"How much balance is left in","description":"Show the Fast2SMS wallet balance (rupees) and the number of SMS the balance covers. Use for \"How much balance is left in my Fast2SMS wallet\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_wallet_balanceArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_sms_summary":{"post":{"operationId":"get_sms_summary","summary":"Get counts of SMS sent, delivered, pending, failed, blocked and errored between two dates. Numbers and message text are ","description":"Get counts of SMS sent, delivered, pending, failed, blocked and errored between two dates. Numbers and message text are not returned. Use for \"How many Fast2SMS messages were delivered or failed this month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"date_from":{"description":"First day, format YYYY-MM-DD.","maxLength":10,"title":"Date From","type":"string"},"date_to":{"description":"Last day, format YYYY-MM-DD.","maxLength":10,"title":"Date To","type":"string"}},"required":["date_from","date_to"],"title":"get_sms_summaryArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_dlt_sender_ids":{"post":{"operationId":"list_dlt_sender_ids","summary":"List the DLT-registered sender IDs (headers) on the account with their principal entity id and entity name. Use for \"Whi","description":"List the DLT-registered sender IDs (headers) on the account with their principal entity id and entity name. Use for \"Which DLT sender IDs are registered on my Fast2SMS account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"anyOf":[{"const":"sender","type":"string"},{"type":"null"}],"default":"sender","description":"What to list; only sender (sender IDs) is supported here.","title":"Type"}},"title":"list_dlt_sender_idsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_whatsapp_overview":{"post":{"operationId":"get_whatsapp_overview","summary":"List the connected WhatsApp Business numbers with WABA id, phone number id, verified name, name approval status, quality","description":"List the connected WhatsApp Business numbers with WABA id, phone number id, verified name, name approval status, quality rating, messaging limit, platform and connection status; with type=template the approved templates of each number are included. Use for \"What are the quality rating and messaging limit of my WhatsApp numbers on Fast2SMS\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"description":"number for numbers only, template to include templates (name, category, status, language).","enum":["number","template"],"title":"Type","type":"string"},"phone_number_id":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only this WhatsApp phone number id.","title":"Phone Number Id"}},"required":["type"],"title":"get_whatsapp_overviewArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_whatsapp_phone_numbers":{"post":{"operationId":"list_whatsapp_phone_numbers","summary":"List the phone numbers of a WhatsApp Business Account with verified name, verification status, quality rating, platform ","description":"List the phone numbers of a WhatsApp Business Account with verified name, verification status, quality rating, platform and onboarding time. Use for \"Which phone numbers does my WhatsApp Business Account have on Fast2SMS\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"waba_id":{"description":"WhatsApp Business Account id (WABA id, a long number shown in your Fast2SMS WhatsApp settings or returned by get_whatsapp_overview).","maxLength":30,"title":"Waba Id","type":"string"}},"required":["waba_id"],"title":"list_whatsapp_phone_numbersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_whatsapp_phone_number":{"post":{"operationId":"get_whatsapp_phone_number","summary":"Get one WhatsApp number's status, official-business-account flag, display name status, verification, platform and messag","description":"Get one WhatsApp number's status, official-business-account flag, display name status, verification, platform and messaging limit tier. Use for \"What is the messaging limit tier and name status of my WhatsApp number 106540352242922\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"phone_number_id":{"description":"WhatsApp phone number id (not the phone number itself; get it from get_whatsapp_overview or list_whatsapp_phone_numbers).","maxLength":30,"title":"Phone Number Id","type":"string"},"fields":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":"status,is_official_business_account,id,name_status,code_verification_status,display_phone_number,platform_type,messaging_limit_tier,throughput","description":"Comma-separated fields to return.","title":"Fields"}},"required":["phone_number_id"],"title":"get_whatsapp_phone_numberArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_whatsapp_business_profile":{"post":{"operationId":"get_whatsapp_business_profile","summary":"Get a WhatsApp number's public business profile: about text, description, websites, category (vertical) and profile pict","description":"Get a WhatsApp number's public business profile: about text, description, websites, category (vertical) and profile picture URL. Use for \"What does the WhatsApp business profile of number 106540352242922 say\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"phone_number_id":{"description":"WhatsApp phone number id (not the phone number itself; get it from get_whatsapp_overview or list_whatsapp_phone_numbers).","maxLength":30,"title":"Phone Number Id","type":"string"},"fields":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":"about,description,profile_picture_url,websites,vertical","description":"Comma-separated profile fields to return.","title":"Fields"}},"required":["phone_number_id"],"title":"get_whatsapp_business_profileArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_whatsapp_health_status":{"post":{"operationId":"get_whatsapp_health_status","summary":"Get the Meta health status of a WhatsApp Business Account: whether it can send messages and the status of each entity (a","description":"Get the Meta health status of a WhatsApp Business Account: whether it can send messages and the status of each entity (account, phone number, business). Use for \"Can my WhatsApp Business Account on Fast2SMS send messages right now\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"waba_id":{"description":"WhatsApp Business Account id (WABA id, a long number shown in your Fast2SMS WhatsApp settings or returned by get_whatsapp_overview).","maxLength":30,"title":"Waba Id","type":"string"},"fields":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":"health_status","description":"Fields to return; health_status shows send capability.","title":"Fields"}},"required":["waba_id"],"title":"get_whatsapp_health_statusArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}