{"components":{"securitySchemes":{"BearerAuth":{"description":"JWT access token or pk_live_ / pk_test_ ApiKey","scheme":"bearer","type":"http"}}},"info":{"description":"Generated from Widely consumer UIConfigs and code catalogs. Same facts PA and Support use. Authenticate to call; this document is public.","title":"Widely Mobile consumer API","version":"1.0.0"},"openapi":"3.0.3","paths":{"/api/account/":{"get":{"parameters":[{"in":"query","name":"consumer_user_id","schema":{"type":"string"}},{"in":"query","name":"consumer_id","schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"summary":"List Account"},"post":{"security":[{"BearerAuth":[]}],"summary":"Create Account"}},"/api/account/{id}":{"delete":{"security":[{"BearerAuth":[]}],"summary":"Delete Account"},"get":{"security":[{"BearerAuth":[]}],"summary":"Get Account"},"put":{"security":[{"BearerAuth":[]}],"summary":"Update Account"}},"/api/apikey/":{"get":{"parameters":[{"in":"query","name":"consumer_user_id","schema":{"type":"string"}},{"in":"query","name":"consumer_id","schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"summary":"List ApiKey"},"post":{"security":[{"BearerAuth":[]}],"summary":"Create ApiKey"}},"/api/apikey/{id}":{"delete":{"security":[{"BearerAuth":[]}],"summary":"Delete ApiKey"},"get":{"security":[{"BearerAuth":[]}],"summary":"Get ApiKey"},"put":{"security":[{"BearerAuth":[]}],"summary":"Update ApiKey"}},"/api/balance_and_payment_routes/get-balance":{"get":{"security":[{"BearerAuth":[]}],"summary":"Wallet available_balance and currency"}},"/api/broadcastlist/":{"get":{"parameters":[{"in":"query","name":"consumer_user_id","schema":{"type":"string"}},{"in":"query","name":"consumer_id","schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"summary":"List BroadcastList"},"post":{"security":[{"BearerAuth":[]}],"summary":"Create BroadcastList"}},"/api/broadcastlist/{id}":{"delete":{"security":[{"BearerAuth":[]}],"summary":"Delete BroadcastList"},"get":{"security":[{"BearerAuth":[]}],"summary":"Get BroadcastList"},"put":{"security":[{"BearerAuth":[]}],"summary":"Update BroadcastList"}},"/api/call_forwarding/setup_call_forwarding":{"post":{"security":[{"BearerAuth":[]}],"summary":"Start Receive SIM calls for a verified number"}},"/api/call_forwarding/test_forwarding":{"post":{"security":[{"BearerAuth":[]}],"summary":"Place the verification call used to prove SIM forwarding"}},"/api/callerid/":{"get":{"parameters":[{"in":"query","name":"consumer_user_id","schema":{"type":"string"}},{"in":"query","name":"consumer_id","schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"summary":"List CallerID"},"post":{"security":[{"BearerAuth":[]}],"summary":"Create CallerID"}},"/api/callerid/{id}":{"delete":{"security":[{"BearerAuth":[]}],"summary":"Delete CallerID"},"get":{"security":[{"BearerAuth":[]}],"summary":"Get CallerID"},"put":{"security":[{"BearerAuth":[]}],"summary":"Update CallerID"}},"/api/callqueue/":{"get":{"parameters":[{"in":"query","name":"consumer_user_id","schema":{"type":"string"}},{"in":"query","name":"consumer_id","schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"summary":"List CallQueue"},"post":{"security":[{"BearerAuth":[]}],"summary":"Create CallQueue"}},"/api/callqueue/{id}":{"delete":{"security":[{"BearerAuth":[]}],"summary":"Delete CallQueue"},"get":{"security":[{"BearerAuth":[]}],"summary":"Get CallQueue"},"put":{"security":[{"BearerAuth":[]}],"summary":"Update CallQueue"}},"/api/consumeruser/":{"get":{"parameters":[{"in":"query","name":"consumer_user_id","schema":{"type":"string"}},{"in":"query","name":"consumer_id","schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"summary":"List ConsumerUser"},"post":{"security":[{"BearerAuth":[]}],"summary":"Create ConsumerUser"}},"/api/consumeruser/{id}":{"delete":{"security":[{"BearerAuth":[]}],"summary":"Delete ConsumerUser"},"get":{"security":[{"BearerAuth":[]}],"summary":"Get ConsumerUser"},"put":{"security":[{"BearerAuth":[]}],"summary":"Update ConsumerUser"}},"/api/consumeruserinvite/":{"get":{"parameters":[{"in":"query","name":"consumer_user_id","schema":{"type":"string"}},{"in":"query","name":"consumer_id","schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"summary":"List ConsumerUserInvite"},"post":{"security":[{"BearerAuth":[]}],"summary":"Create ConsumerUserInvite"}},"/api/consumeruserinvite/{id}":{"delete":{"security":[{"BearerAuth":[]}],"summary":"Delete ConsumerUserInvite"},"get":{"security":[{"BearerAuth":[]}],"summary":"Get ConsumerUserInvite"},"put":{"security":[{"BearerAuth":[]}],"summary":"Update ConsumerUserInvite"}},"/api/did/":{"get":{"parameters":[{"in":"query","name":"consumer_user_id","schema":{"type":"string"}},{"in":"query","name":"consumer_id","schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"summary":"List DID"},"post":{"security":[{"BearerAuth":[]}],"summary":"Create DID"}},"/api/did/{id}":{"delete":{"security":[{"BearerAuth":[]}],"summary":"Delete DID"},"get":{"security":[{"BearerAuth":[]}],"summary":"Get DID"},"put":{"security":[{"BearerAuth":[]}],"summary":"Update DID"}},"/api/extension/":{"get":{"parameters":[{"in":"query","name":"consumer_user_id","schema":{"type":"string"}},{"in":"query","name":"consumer_id","schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"summary":"List Extension"},"post":{"security":[{"BearerAuth":[]}],"summary":"Create Extension"}},"/api/extension/{id}":{"delete":{"security":[{"BearerAuth":[]}],"summary":"Delete Extension"},"get":{"security":[{"BearerAuth":[]}],"summary":"Get Extension"},"put":{"security":[{"BearerAuth":[]}],"summary":"Update Extension"}},"/api/ivrconfig/":{"get":{"parameters":[{"in":"query","name":"consumer_user_id","schema":{"type":"string"}},{"in":"query","name":"consumer_id","schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"summary":"List IVRConfig"},"post":{"security":[{"BearerAuth":[]}],"summary":"Create IVRConfig"}},"/api/ivrconfig/{id}":{"delete":{"security":[{"BearerAuth":[]}],"summary":"Delete IVRConfig"},"get":{"security":[{"BearerAuth":[]}],"summary":"Get IVRConfig"},"put":{"security":[{"BearerAuth":[]}],"summary":"Update IVRConfig"}},"/api/lcr/":{"get":{"parameters":[{"in":"query","name":"consumer_user_id","schema":{"type":"string"}},{"in":"query","name":"consumer_id","schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"summary":"List LCR"},"post":{"security":[{"BearerAuth":[]}],"summary":"Create LCR"}},"/api/lcr/{id}":{"delete":{"security":[{"BearerAuth":[]}],"summary":"Delete LCR"},"get":{"security":[{"BearerAuth":[]}],"summary":"Get LCR"},"put":{"security":[{"BearerAuth":[]}],"summary":"Update LCR"}},"/api/lcrtrunk/":{"get":{"parameters":[{"in":"query","name":"consumer_user_id","schema":{"type":"string"}},{"in":"query","name":"consumer_id","schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"summary":"List LCRTrunk"},"post":{"security":[{"BearerAuth":[]}],"summary":"Create LCRTrunk"}},"/api/lcrtrunk/{id}":{"delete":{"security":[{"BearerAuth":[]}],"summary":"Delete LCRTrunk"},"get":{"security":[{"BearerAuth":[]}],"summary":"Get LCRTrunk"},"put":{"security":[{"BearerAuth":[]}],"summary":"Update LCRTrunk"}},"/api/membership/channel-quote":{"get":{"security":[{"BearerAuth":[]}],"summary":"Read-only price for extra DID channels"}},"/api/membership/downgrade":{"post":{"security":[{"BearerAuth":[]}],"summary":"Schedule a tier downgrade at period end"}},"/api/membership/plans":{"get":{"security":[{"BearerAuth":[]}],"summary":"Platform tiers with capabilities for the signed-in account"}},"/api/membership/plans/public":{"get":{"summary":"Public Free/Pro/Business cards (no session)"}},"/api/membership/sip-channel-pool":{"get":{"security":[{"BearerAuth":[]}],"summary":"Shared SIP channel pack capacity for the account"},"post":{"security":[{"BearerAuth":[]}],"summary":"Commit SIP pack change: confirm=true plus quoted_charge echo"}},"/api/membership/sip-channel-pool/quote":{"get":{"security":[{"BearerAuth":[]}],"summary":"Read-only price for a SIP channel pack change"}},"/api/membership/upgrade":{"post":{"security":[{"BearerAuth":[]}],"summary":"Upgrade platform tier; debit the Consumer wallet"}},"/api/pricing/public/check-call-rate":{"post":{"summary":"Indicative per-minute call rate"}},"/api/pricing/public/countries":{"get":{"summary":"Server-rendered live country data-pricing index"}},"/api/pricing/public/country/{country_slug}":{"get":{"parameters":[{"in":"path","name":"country_slug","required":true,"schema":{"type":"string"}}],"summary":"Server-rendered live rates and 1/5/10/20/50 GB totals in all public currencies"}},"/api/pricing/public/data-estimate/{country_code}/{currency}/{gb}":{"get":{"parameters":[{"in":"path","name":"country_code","required":true,"schema":{"maxLength":2,"minLength":2,"type":"string"}},{"in":"path","name":"currency","required":true,"schema":{"enum":["GBP","EUR","USD","ILS"],"type":"string"}},{"in":"path","name":"gb","required":true,"schema":{"exclusiveMinimum":0,"format":"double","type":"number"}}],"summary":"Exact path-based PAYG data estimate for a country, currency, and decimal GB amount"}},"/api/pricing/public/data-rate-card":{"get":{"parameters":[{"in":"query","name":"currency","schema":{"enum":["GBP","EUR","USD","ILS"],"type":"string"}},{"in":"query","name":"country_code","schema":{"maxLength":2,"minLength":2,"type":"string"}},{"in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"include_samples","schema":{"type":"boolean"}}],"summary":"PAYG eSIM rate card; volume ranges are marginal, not flat rates"}},"/api/pricing/public/did-rates":{"get":{"summary":"Indicative DID monthly/setup rates"}},"/api/pricing/public/estimate-data-cost":{"post":{"summary":"Estimate PAYG data cost for country + GB"}},"/api/rate/":{"get":{"parameters":[{"in":"query","name":"consumer_user_id","schema":{"type":"string"}},{"in":"query","name":"consumer_id","schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"summary":"List Rate"},"post":{"security":[{"BearerAuth":[]}],"summary":"Create Rate"}},"/api/rate/{id}":{"delete":{"security":[{"BearerAuth":[]}],"summary":"Delete Rate"},"get":{"security":[{"BearerAuth":[]}],"summary":"Get Rate"},"put":{"security":[{"BearerAuth":[]}],"summary":"Update Rate"}},"/api/ratesheet/":{"get":{"parameters":[{"in":"query","name":"consumer_user_id","schema":{"type":"string"}},{"in":"query","name":"consumer_id","schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"summary":"List RateSheet"},"post":{"security":[{"BearerAuth":[]}],"summary":"Create RateSheet"}},"/api/ratesheet/{id}":{"delete":{"security":[{"BearerAuth":[]}],"summary":"Delete RateSheet"},"get":{"security":[{"BearerAuth":[]}],"summary":"Get RateSheet"},"put":{"security":[{"BearerAuth":[]}],"summary":"Update RateSheet"}},"/api/routingrule/":{"get":{"parameters":[{"in":"query","name":"consumer_user_id","schema":{"type":"string"}},{"in":"query","name":"consumer_id","schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"summary":"List RoutingRule"},"post":{"security":[{"BearerAuth":[]}],"summary":"Create RoutingRule"}},"/api/routingrule/{id}":{"delete":{"security":[{"BearerAuth":[]}],"summary":"Delete RoutingRule"},"get":{"security":[{"BearerAuth":[]}],"summary":"Get RoutingRule"},"put":{"security":[{"BearerAuth":[]}],"summary":"Update RoutingRule"}},"/api/sharedtrunk/":{"get":{"parameters":[{"in":"query","name":"consumer_user_id","schema":{"type":"string"}},{"in":"query","name":"consumer_id","schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"summary":"List SharedTrunk"},"post":{"security":[{"BearerAuth":[]}],"summary":"Create SharedTrunk"}},"/api/sharedtrunk/{id}":{"delete":{"security":[{"BearerAuth":[]}],"summary":"Delete SharedTrunk"},"get":{"security":[{"BearerAuth":[]}],"summary":"Get SharedTrunk"},"put":{"security":[{"BearerAuth":[]}],"summary":"Update SharedTrunk"}},"/api/sim_orders/sims/purchase":{"post":{"security":[{"BearerAuth":[]}],"summary":"Provision a PAYG eSIM (wallet debit; install-first / platform cap apply)"}},"/api/siptrunk/":{"get":{"parameters":[{"in":"query","name":"consumer_user_id","schema":{"type":"string"}},{"in":"query","name":"consumer_id","schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"summary":"List SipTrunk"},"post":{"security":[{"BearerAuth":[]}],"summary":"Create SipTrunk"}},"/api/siptrunk/{id}":{"delete":{"security":[{"BearerAuth":[]}],"summary":"Delete SipTrunk"},"get":{"security":[{"BearerAuth":[]}],"summary":"Get SipTrunk"},"put":{"security":[{"BearerAuth":[]}],"summary":"Update SipTrunk"}},"/api/timegroup/":{"get":{"parameters":[{"in":"query","name":"consumer_user_id","schema":{"type":"string"}},{"in":"query","name":"consumer_id","schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"summary":"List TimeGroup"},"post":{"security":[{"BearerAuth":[]}],"summary":"Create TimeGroup"}},"/api/timegroup/{id}":{"delete":{"security":[{"BearerAuth":[]}],"summary":"Delete TimeGroup"},"get":{"security":[{"BearerAuth":[]}],"summary":"Get TimeGroup"},"put":{"security":[{"BearerAuth":[]}],"summary":"Update TimeGroup"}},"/api/user/":{"get":{"parameters":[{"in":"query","name":"consumer_user_id","schema":{"type":"string"}},{"in":"query","name":"consumer_id","schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"summary":"List User"},"post":{"security":[{"BearerAuth":[]}],"summary":"Create User"}},"/api/user/{id}":{"delete":{"security":[{"BearerAuth":[]}],"summary":"Delete User"},"get":{"security":[{"BearerAuth":[]}],"summary":"Get User"},"put":{"security":[{"BearerAuth":[]}],"summary":"Update User"}},"/api/verifiednumber/":{"get":{"parameters":[{"in":"query","name":"consumer_user_id","schema":{"type":"string"}},{"in":"query","name":"consumer_id","schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"summary":"List VerifiedNumber"},"post":{"security":[{"BearerAuth":[]}],"summary":"Create VerifiedNumber"}},"/api/verifiednumber/{id}":{"delete":{"security":[{"BearerAuth":[]}],"summary":"Delete VerifiedNumber"},"get":{"security":[{"BearerAuth":[]}],"summary":"Get VerifiedNumber"},"put":{"security":[{"BearerAuth":[]}],"summary":"Update VerifiedNumber"}},"/api/voip/check-rate":{"post":{"security":[{"BearerAuth":[]}],"summary":"Signed-in rate checker (same engine as the app)"}}},"servers":[{"url":"https://api.swiftcom.cc"}]}