{"openapi":"3.1.0","info":{"title":"REST Platform Management","version":"1.0.0"},"paths":{"/Users":{"post":{"operationId":"users_createUser","summary":"create a new user","tags":["users"],"responses":{"200":{"description":"user created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users_createUser_Response_200"}}}},"403":{"description":"user creation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"username"},"email":{"type":"string","description":"user email address"},"is_active":{"type":"boolean","description":"user account is active"},"force_change":{"type":"boolean","description":"require the user to change password on next login"},"initial_password":{"type":"string","description":"users password"},"account_sid":{"type":"string","format":"uuid","description":"account sid the account the user will have access to, if not set will create a Service Provider account"},"service_provider_sid":{"type":"string","format":"uuid","description":"The service provider sid, the account is under, if not set account will be admin level"},"is_view_only":{"type":"boolean","description":"if set to true the user will not be able to make changes"}},"required":["name","email","is_active","force_change","initial_password","is_view_only"]}}}},"security":[{"bearerAuth":[]}]}},"/Users/{UserSid}":{"get":{"operationId":"users_getUser","summary":"retrieve user information","tags":["users"],"parameters":[{"name":"UserSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"user information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users_getUser_Response_200"}}}},"403":{"description":"user information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"users_updateUser","summary":"update user information","tags":["users"],"parameters":[{"name":"UserSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"user updated","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"403":{"description":"user update failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"email_activation_code":{"type":"string"},"old_password":{"type":"string","description":"existing password, which is to be replaced"},"new_password":{"type":"string","description":"new password"},"is_active":{"type":"boolean"},"force_change":{"type":"boolean"},"is_view_only":{"type":"boolean","description":"if set to true the user will not be able to make changes"}}}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"users_deleteUser","summary":"delete a user","tags":["users"],"parameters":[{"name":"UserSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"user deleted","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"403":{"description":"unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"user not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/MicrosoftTeamsTenants":{"get":{"operationId":"settings_listMsTeamsTenants","summary":"list MS Teams tenants","tags":["settings"],"responses":{"200":{"description":"list of tenants","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MsTeamsTenant"}}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"settings_createMsTeamsTenant","summary":"provision a customer tenant for MS Teams","tags":["settings"],"responses":{"201":{"description":"tenant successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulAdd"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"service_provider_sid":{"type":"string","format":"uuid"},"account_sid":{"type":"string","format":"uuid"},"application_sid":{"type":"string","format":"uuid"},"tenant_fqdn":{"type":"string"}},"required":["service_provider_sid","tenant_fqdn"]}}}},"security":[{"bearerAuth":[]}]}},"/MicrosoftTeamsTenants/{TenantSid}":{"get":{"operationId":"settings_getTenant","summary":"retrieve an MS Teams tenant","tags":["settings"],"parameters":[{"name":"TenantSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"tenant found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MsTeamsTenant"}}}},"404":{"description":"account not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"settings_putTenant","summary":"update an MS Teams tenant","tags":["settings"],"parameters":[{"name":"TenantSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"tenant updated","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"tenant not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MsTeamsTenant"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"settings_deleteTenant","summary":"delete an MS Teams tenant","tags":["settings"],"parameters":[{"name":"TenantSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"tenant successfully deleted","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"tenant not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/Availability":{"get":{"operationId":"accounts_checkAvailability","summary":"check if a limited-availability entity such as a subdomain, email or phone number is already in use","tags":["accounts"],"parameters":[{"name":"type","in":"query","required":true,"schema":{"$ref":"#/components/schemas/AvailabilityGetParametersType"}},{"name":"value","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"indicates whether value is already in use","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Accounts_checkAvailability_Response_200"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/Accounts":{"get":{"operationId":"accounts_listAccounts","summary":"list accounts","tags":["accounts"],"responses":{"200":{"description":"list of accounts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Account"}}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"accounts_createAccount","summary":"create an account","tags":["accounts"],"responses":{"201":{"description":"account successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulAdd"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"account name"},"sip_realm":{"type":"string","description":"sip realm for registration"},"registration_hook":{"$ref":"#/components/schemas/Webhook","description":"authentication webhook for registration"},"queue_event_hook":{"$ref":"#/components/schemas/Webhook","description":"webhook called when members join or leave a queue"},"service_provider_sid":{"type":"string","format":"uuid"}},"required":["name","service_provider_sid"]}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}":{"get":{"operationId":"accounts_getAccount","summary":"retrieve account","tags":["accounts"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"account found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"404":{"description":"account not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"accounts_updateAccount","summary":"update account","tags":["accounts"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"account updated","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"account not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"accounts_deleteAccount","summary":"delete an account","tags":["accounts"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"account successfully deleted","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"account not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}/WebhookSecret":{"get":{"operationId":"accounts_getWebhookSecret","summary":"get webhook signing secret, regenerating if requested","tags":["accounts"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"regenerate","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"secret","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Accounts_getWebhookSecret_Response_200"}}}},"404":{"description":"account not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}/SipRealms/{SipRealm}":{"post":{"operationId":"accounts_createSipRealm","summary":"add or change the sip realm","tags":["accounts"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"SipRealm","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"sip_realm updated and DNS entries successfully created","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}/Limits":{"get":{"operationId":"accounts_getAccountLimits","summary":"retrieve call capacity and other limits from the account","tags":["accounts"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"account limits","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Limits"}}}}},"404":{"description":"account not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"accounts_addLimitForAccount","summary":"create a limit for an account","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["accounts"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"201":{"description":"limit successfully created or updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulAdd"}}}},"404":{"description":"account not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Limits"}}}},"security":[{"bearerAuth":[]}]}},"/ApiKeys":{"get":{"operationId":"accounts_getAccountApiKeys","summary":"get all api keys for an account","tags":["accounts"],"responses":{"200":{"description":"list of api keys","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiKey"}}}}},"404":{"description":"account not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"accounts_createApiKey","summary":"create an API key for an account","tags":["accounts"],"responses":{"200":{"description":"new API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Accounts_createApiKey_Response_200"}}}},"404":{"description":"account not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"account_sid":{"type":"string","format":"uuid"}},"required":["account_sid"]}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}/RegisteredSipUsers":{"get":{"operationId":"clients_listRegisteredSipUsers","summary":"retrieve online sip users for an account","tags":["clients"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"retrieve online sip users for an account","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"clients_listRegisteredSipUsersByUsername","summary":"retrieve online sip users for an account by list of sip username","tags":["clients"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"retrieve online sip users for an account","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RegisteredClient"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}/RegisteredSipUsers/{Client}":{"get":{"operationId":"clients_getRegisteredClient","summary":"retrieve registered client registration","tags":["clients"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Client","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"registered client found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisteredClient"}}}}},"security":[{"bearerAuth":[]}]}},"/Clients":{"get":{"operationId":"clients_getClients","summary":"List Clients","description":"Returns a list of clients","tags":["clients"],"responses":{"200":{"description":"retrieve online sip users for an account","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClientsGetResponsesContentApplicationJsonSchemaItems"}}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"clients_createClient","summary":"Create a new client","description":"Creates a new sip client","tags":["clients"],"responses":{"201":{"description":"Client created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Clients_createClient_Response_201"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateClientRequestBadRequestError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"account_sid":{"type":"string","format":"uuid"},"username":{"type":"string"},"password":{"type":"string"},"is_active":{"$ref":"#/components/schemas/ClientsPostRequestBodyContentApplicationJsonSchemaIsActive","default":1},"allow_direct_app_calling":{"$ref":"#/components/schemas/ClientsPostRequestBodyContentApplicationJsonSchemaAllowDirectAppCalling","default":1},"allow_direct_queue_calling":{"$ref":"#/components/schemas/ClientsPostRequestBodyContentApplicationJsonSchemaAllowDirectQueueCalling","default":1},"allow_direct_user_calling":{"$ref":"#/components/schemas/ClientsPostRequestBodyContentApplicationJsonSchemaAllowDirectUserCalling","default":1}},"required":["account_sid","username","password"]}}}},"security":[{"bearerAuth":[]}]}},"/Clients/{ClientSid}":{"get":{"operationId":"clients_getClient","summary":"Get a client","description":"Get details of a single client","tags":["clients"],"parameters":[{"name":"ClientSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"details of a client","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Clients_getClient_Response_200"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"clients_updateClient","summary":"Update a client","description":"Changes properties on an existing client","tags":["clients"],"parameters":[{"name":"ClientSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Client updated","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"ClientSid not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"is_active":{"$ref":"#/components/schemas/ClientsClientSidPutRequestBodyContentApplicationJsonSchemaIsActive","default":1},"allow_direct_app_calling":{"$ref":"#/components/schemas/ClientsClientSidPutRequestBodyContentApplicationJsonSchemaAllowDirectAppCalling","default":1},"allow_direct_queue_calling":{"$ref":"#/components/schemas/ClientsClientSidPutRequestBodyContentApplicationJsonSchemaAllowDirectQueueCalling","default":1},"allow_direct_user_calling":{"$ref":"#/components/schemas/ClientsClientSidPutRequestBodyContentApplicationJsonSchemaAllowDirectUserCalling","default":1}}}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"clients_deleteClient","summary":"delete a client","description":"removes an existing client","tags":["clients"],"parameters":[{"name":"ClientSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Client deleted","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"ClientSid not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]}},"/Webhooks/{WebhookSid}":{"get":{"operationId":"applications_getWebhook","summary":"retrieve webhook","tags":["applications"],"parameters":[{"name":"WebhookSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"webhook found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}},"404":{"description":"webhook not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/Applications":{"get":{"operationId":"applications_listApplications","summary":"list applications","tags":["applications"],"responses":{"200":{"description":"list of applications","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Application"}}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"applications_createApplication","summary":"create application","tags":["applications"],"responses":{"201":{"description":"application successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulAdd"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"application name"},"account_sid":{"type":"string","format":"uuid"},"call_hook":{"$ref":"#/components/schemas/Webhook","description":"application webhook to handle inbound voice calls"},"call_status_hook":{"$ref":"#/components/schemas/Webhook","description":"webhook to report call status events"},"messaging_hook":{"$ref":"#/components/schemas/Webhook","description":"application webhook to handle inbound SMS/MMS messages"},"app_json":{"type":"string","description":"Voice Application Json, call_hook will not be invoked if app_json is provided"},"speech_synthesis_vendor":{"type":"string"},"speech_synthesis_voice":{"type":"string"},"speech_recognizer_vendor":{"type":"string"},"speech_recognizer_language":{"type":"string"},"env_vars":{"$ref":"#/components/schemas/ApplicationsPostRequestBodyContentApplicationJsonSchemaEnvVars","description":"Object containing the Application Environment Variables as key/value to be sent with the call_hook payload"}},"required":["name","account_sid","call_hook","call_status_hook"]}}}},"security":[{"bearerAuth":[]}]}},"/Applications/{ApplicationSid}":{"get":{"operationId":"applications_retrieveAnApplication","summary":"retrieve an application","tags":["applications"],"parameters":[{"name":"ApplicationSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"application found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}}},"404":{"description":"application not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"applications_updateApplication","summary":"update application","tags":["applications"],"parameters":[{"name":"ApplicationSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"application updated","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"application not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"applications_deleteApplication","summary":"delete an application","tags":["applications"],"parameters":[{"name":"ApplicationSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"application successfully deleted","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"application not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/AppEnv":{"get":{"operationId":"applications_getAppEnvSchema","summary":"Get App Env Schema","tags":["applications"],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"App Env Schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Applications_getAppEnvSchema_Response_200"}}}},"400":{"description":"The App Env Schma that was returned was invalid","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}/RecentCalls":{"get":{"operationId":"recentCalls_listRecentCalls","summary":"retrieve recent calls for an account","tags":["recentCalls"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer"}},{"name":"count","in":"query","required":true,"schema":{"type":"integer","minimum":1,"maximum":500}},{"name":"days","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":30}},{"name":"start","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"end","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"answered","in":"query","required":false,"schema":{"$ref":"#/components/schemas/AccountsAccountSidRecentCallsGetParametersAnswered"}},{"name":"direction","in":"query","required":false,"schema":{"$ref":"#/components/schemas/AccountsAccountSidRecentCallsGetParametersDirection"}},{"name":"filter","in":"query","description":"Filter value can be caller ID, callee ID or call Sid","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"retrieve recent call records for a specified account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recent_Calls_listRecentCalls_Response_200"}}}},"404":{"description":"account not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}/RecentCalls/trace/{CallId}":{"get":{"operationId":"recentCalls_getRecentCallTrace","summary":"retrieve jaeger trace detail for a call","tags":["recentCalls"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"CallId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"retrieve trace data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recent_Calls_getRecentCallTrace_Response_200"}}}},"404":{"description":"account or call not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}/RecentCalls/{CallSid}/record/{YYYY}/{MM}/{DD}/{FORMAT}":{"get":{"operationId":"recentCalls_getRecentCallRecording","summary":"retrieve recording for a call","tags":["recentCalls"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"CallSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"YYYY","in":"path","required":true,"schema":{"type":"string"}},{"name":"MM","in":"path","required":true,"schema":{"type":"string"}},{"name":"DD","in":"path","required":true,"schema":{"type":"string"}},{"name":"FORMAT","in":"path","required":true,"schema":{"$ref":"#/components/schemas/AccountsAccountSidRecentCallsCallSidRecordYyyyMmDdFormatGetParametersFormat"}}],"responses":{"200":{"description":"call audio file","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recent_Calls_getRecentCallRecording_Response_200"}}}},"404":{"description":"recording or call not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}/RecentCalls/{CallId}/pcap":{"get":{"operationId":"recentCalls_getRecentCallTraceByAccount","summary":"retrieve pcap for a call","tags":["recentCalls"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"CallId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"retrieve sip trace data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recent_Calls_getRecentCallTraceByAccount_Response_200"}}}},"404":{"description":"account or call not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]}},"/ServiceProviders/{ServiceProviderSid}/RecentCalls/{CallId}/pcap":{"get":{"operationId":"recentCalls_getRecentCallTraceBySP","summary":"retrieve pcap for a call","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["recentCalls"],"parameters":[{"name":"ServiceProviderSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"CallId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"retrieve sip trace data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recent_Calls_getRecentCallTraceBySP_Response_200"}}}},"404":{"description":"account or call not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]}},"/ServiceProviders/{ServiceProviderSid}/RecentCalls":{"get":{"operationId":"recentCalls_listRecentCallsBySP","summary":"retrieve recent calls for an account","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["recentCalls"],"parameters":[{"name":"ServiceProviderSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer"}},{"name":"count","in":"query","required":true,"schema":{"type":"integer"}},{"name":"days","in":"query","required":false,"schema":{"type":"integer"}},{"name":"start","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"end","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"answered","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ServiceProvidersServiceProviderSidRecentCallsGetParametersAnswered"}},{"name":"direction","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ServiceProvidersServiceProviderSidRecentCallsGetParametersDirection"}},{"name":"from","in":"query","description":"calling number to retrieve","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","description":"called number to retrieve","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"retrieve recent call records for a specified account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recent_Calls_listRecentCallsBySP_Response_200"}}}},"404":{"description":"account not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]}},"/ServiceProviders/{ServiceProviderSid}/RecentCalls/trace/{CallId}":{"get":{"operationId":"recentCalls_getRecentCallTraceByCallId","summary":"retrieve jaeger trace detail for a call","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["recentCalls"],"parameters":[{"name":"ServiceProviderSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"CallId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"retrieve trace data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recent_Calls_getRecentCallTraceByCallId_Response_200"}}}},"404":{"description":"service provider or call not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}/Alerts":{"get":{"operationId":"alerts_listAlertsByAccount","summary":"retrieve alerts for an account","tags":["alerts"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer"}},{"name":"count","in":"query","required":true,"schema":{"type":"integer","minimum":1,"maximum":500}},{"name":"days","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":30}},{"name":"start","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"end","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"alert_type","in":"query","required":false,"schema":{"$ref":"#/components/schemas/AccountsAccountSidAlertsGetParametersAlertType"}}],"responses":{"200":{"description":"retrieve alerts for a specified account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alerts_listAlertsByAccount_Response_200"}}}},"404":{"description":"account not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}/AlertHooks":{"get":{"operationId":"alerts_listAlertHooks","summary":"list alert hooks","tags":["alerts"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"list of alert hooks for the account","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertHook"}}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"alerts_createAlertHook","summary":"create an alert hook","description":"Adds an external destination that every new alert for the account is pushed to as it happens. An account may have at most 5 alert hooks.","tags":["alerts"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"201":{"description":"alert hook successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulAdd"}}}},"400":{"description":"invalid type or address, email is not available on this platform, or the account already has 5 alert hooks","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AlertHookType"},"address":{"type":"string","description":"json and slack - an https URL (a Slack incoming webhook URL for slack); pagerduty - an Events API v2 routing key; email - an email address"}},"required":["type","address"]}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}/AlertHooks/test":{"post":{"operationId":"alerts_testAlertHooks","summary":"send a test alert","description":"Sends a test alert to a single alert hook when alert_hook_sid is provided, otherwise to every alert hook on the account, and reports the delivery result per hook.","tags":["alerts"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"per-hook delivery results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alerts_testAlertHooks_Response_200"}}}},"400":{"description":"alert hook delivery is not available on this server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"404":{"description":"alert_hook_sid not found for this account","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"alert_hook_sid":{"type":"string","format":"uuid","description":"test only this alert hook; omit to test all of the account's alert hooks"}}}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}/AlertHooks/capabilities":{"get":{"operationId":"alerts_getAlertHookCapabilities","summary":"get alert hook capabilities","description":"Reports which alert hook types this platform can deliver.","tags":["alerts"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"alert hook capabilities","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alerts_getAlertHookCapabilities_Response_200"}}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}/AlertHooks/{AlertHookSid}":{"get":{"operationId":"alerts_getAlertHook","summary":"retrieve an alert hook","tags":["alerts"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"AlertHookSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"alert hook found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertHook"}}}},"404":{"description":"alert hook not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"alerts_updateAlertHook","summary":"update an alert hook","tags":["alerts"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"AlertHookSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"alert hook updated","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"invalid type or address","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"404":{"description":"alert hook not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AlertHookType"},"address":{"type":"string"}}}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"alerts_deleteAlertHook","summary":"delete an alert hook","tags":["alerts"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"AlertHookSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"alert hook deleted","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"alert hook not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]}},"/Sbcs":{"get":{"operationId":"carriers_listSbcs","summary":"retrieve public IP addresses of the jambonz SBCs","tags":["carriers"],"parameters":[{"name":"service_provider_sid","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"list of SBC addresses","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SbcsGetResponsesContentApplicationJsonSchemaItems"}}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/VoipCarriers/{VoipCarrierSid}":{"get":{"operationId":"carriers_getVoipCarrier","summary":"retrieve voip carrier","tags":["carriers"],"parameters":[{"name":"VoipCarrierSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"voip carrier found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoipCarrier"}}}},"404":{"description":"voip carrier not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"carriers_updateVoipCarrier","summary":"update voip carrier","tags":["carriers"],"parameters":[{"name":"VoipCarrierSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"voip carrier updated","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"404":{"description":"voip carrier not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoipCarrier"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"carriers_deleteVoipCarrier","summary":"delete a voip carrier","tags":["carriers"],"parameters":[{"name":"VoipCarrierSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"voip carrier successfully deleted","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"voip carrier not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/SipGateways":{"get":{"operationId":"carriers_listSipGateways","summary":"list sip gateways","tags":["carriers"],"parameters":[{"name":"voip_carrier_sid","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"list of sip gateways","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SipGateway"}}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"carriers_createSipGateway","summary":"create sip gateway","tags":["carriers"],"responses":{"201":{"description":"sip gateway successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulAdd"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"voip_carrier_sid":{"type":"string","format":"uuid","description":"voip carrier that provides this gateway"},"ipv4":{"type":"string"},"netmask":{"type":"integer"},"port":{"type":"integer"},"is_active":{"type":"boolean"},"inbound":{"type":"boolean"},"outbound":{"type":"boolean"}},"required":["voip_carrier_sid","ipv4"]}}}},"security":[{"bearerAuth":[]}]}},"/SipGateways/{SipGatewaySid}":{"get":{"operationId":"carriers_getSipGateway","summary":"retrieve sip gateway","tags":["carriers"],"parameters":[{"name":"SipGatewaySid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"sip gateway found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SipGateway"}}}},"404":{"description":"sip gateway not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"carriers_updateSipGateway","summary":"update sip gateway","tags":["carriers"],"parameters":[{"name":"SipGatewaySid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"sip gateway updated","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"404":{"description":"sip gateway not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SipGateway"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"carriers_deleteSipGateway","summary":"delete a sip gateway","tags":["carriers"],"parameters":[{"name":"SipGatewaySid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"sip gateway successfully deleted","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"sip gateway not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/ServiceProviders/{ServiceProviderSid}/VoipCarriers":{"get":{"operationId":"carriers_getServiceProviderCarriers","summary":"get all carriers availlble to the account","tags":["carriers"],"parameters":[{"name":"ServiceProviderSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"account listing","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoipCarrier"}}}}},"403":{"description":"unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"service provider not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"carriers_createCarrierForServiceProvider","summary":"create a carrier as a service provider","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["carriers"],"parameters":[{"name":"ServiceProviderSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"201":{"description":"service provider successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulAdd"}}}},"404":{"description":"service provider not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoipCarrier"}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}/VoipCarriers":{"get":{"operationId":"carriers_getAccountCarriers","summary":"get all carriers for an account","tags":["carriers"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"carrier listing","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccountsAccountSidVoipCarriersGetResponsesContentApplicationJsonSchemaItems"}}}}},"403":{"description":"unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"service provider not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"carriers_createCarrierForAccount","summary":"create a carrier for an account","tags":["carriers"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"201":{"description":"service provider successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulAdd"}}}},"404":{"description":"service provider not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoipCarrier"}}}},"security":[{"bearerAuth":[]}]}},"/ServiceProviders/{ServiceProviderSid}/PredefinedCarriers/{PredefinedCarrierSid}":{"post":{"operationId":"carriers_createVoipCarrierFromTemplateBySP","summary":"add a carrier to a service provider using a template","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["carriers"],"parameters":[{"name":"ServiceProviderSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"PredefinedCarrierSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"201":{"description":"voip carrier successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulAdd"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}/SpeechCredentials":{"get":{"operationId":"speech_listSpeechCredentials","summary":"retrieve all speech credentials for an account","tags":["speech"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"retrieve speech credentials for a specified account","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SpeechCredential"}}}}},"404":{"description":"account not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"speech_createSpeechCredential","summary":"add a speech credential","tags":["speech"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"201":{"description":"speech credential successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulAdd"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeechCredential"}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}/SpeechCredentials/{SpeechCredentialSid}":{"get":{"operationId":"speech_getSpeechCredentialByAccount","summary":"get a specific speech credential","tags":["speech"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"SpeechCredentialSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"retrieve speech credentials for a specified account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeechCredential"}}}},"404":{"description":"credential not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"speech_updateSpeechCredentialByAccount","summary":"update a speech credential","tags":["speech"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"SpeechCredentialSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"credential successfully deleted","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"credential not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"credential not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeechCredentialUpdate"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"speech_deleteSpeechCredentialByAccount","summary":"delete a speech credential","tags":["speech"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"SpeechCredentialSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"credential successfully deleted","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"credential not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}/SpeechCredentials/speech/supportedLanguagesAndVoices":{"get":{"operationId":"speech_supportedLanguagesAndVoicesByAccount","summary":"get supported languages, voices and models","tags":["speech"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"vendor","in":"query","required":true,"schema":{"type":"string"}},{"name":"label","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"get supported languages, voices and models","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeechLanguagesVoices"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}/SpeechCredentials/{SpeechCredentialSid}/test":{"get":{"operationId":"speech_testSpeechCredentialByAccount","summary":"test a speech credential","tags":["speech"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"SpeechCredentialSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"credential test results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Speech_testSpeechCredentialByAccount_Response_200"}}}},"404":{"description":"credential not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/Accounts/{AccountSid}/TtsCache/Synthesize":{"post":{"operationId":"speech_Synthesize","summary":"get TTS from provider","tags":["speech"],"parameters":[{"name":"AccountSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Audio is created","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"speech_credential_sid":{"type":"string","description":"Speech credential Sid"},"text":{"type":"string","description":"the text to convert to audio"},"language":{"type":"string","description":"language is used in text"},"voice":{"type":"string","description":"voice ID"},"encodingMp3":{"type":"boolean","description":"convert audio to mp3."}},"required":["speech_credential_sid","text","language","voice"]}}}},"security":[{"bearerAuth":[]}]}},"/GoogleCustomVoices":{"get":{"operationId":"speech_listGoogleCustomVoices","summary":"list google custom voices","tags":["speech"],"parameters":[{"name":"service_provider_sid","in":"query","required":false,"schema":{"type":"string"}},{"name":"account_sid","in":"query","required":false,"schema":{"type":"string"}},{"name":"speech_credential_sid","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"list oflist google custom voices","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCustomVoice"}}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"speech_createGoogleCustomVoice","summary":"create a Google custom voice","tags":["speech"],"responses":{"201":{"description":"Least Cost Routing Carrier Set Entry successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulAdd"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCustomVoice"}}}}},"security":[{"bearerAuth":[]}]}},"/GoogleCustomVoices/{GoogleCustomVoiceSid}":{"get":{"operationId":"speech_getGoogleCustomVoice","summary":"retrieve google custom voice","tags":["speech"],"parameters":[{"name":"GoogleCustomVoiceSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"google custom voice found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCustomVoice"}}}},"404":{"description":"google custom voice not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"speech_updateGoogleCustomVoice","summary":"update google custom voice","tags":["speech"],"parameters":[{"name":"GoogleCustomVoiceSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"google custom voice updated","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"404":{"description":"least cost routing carrier set entry not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCustomVoice"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"speech_deleteGoogleCustomVoice","summary":"delete a google custom voice","tags":["speech"],"parameters":[{"name":"GoogleCustomVoiceSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"google custom voice successfully deleted","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"google custom voice not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/ServiceProviders/{ServiceProviderSid}/SpeechCredentials":{"post":{"operationId":"speech_addSpeechCredentialForSeerviceProvider","summary":"create a speech credential for a service provider","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["speech"],"parameters":[{"name":"ServiceProviderSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"201":{"description":"speech credential successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulAdd"}}}},"404":{"description":"credential not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeechCredential"}}}},"security":[{"bearerAuth":[]}]}},"/ServiceProviders/{ServiceProviderSid}/SpeechCredentials/{SpeechCredentialSid}":{"get":{"operationId":"speech_getSpeechCredential","summary":"get a specific speech credential","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["speech"],"parameters":[{"name":"ServiceProviderSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"SpeechCredentialSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"retrieve speech credentials for a specified account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeechCredential"}}}},"404":{"description":"credential not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"speech_updateSpeechCredential","summary":"update a speech credential","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["speech"],"parameters":[{"name":"ServiceProviderSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"SpeechCredentialSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"credential successfully updated","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"credential not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"credential not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeechCredentialUpdate"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"speech_deleteSpeechCredential","summary":"delete a speech credential","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["speech"],"parameters":[{"name":"ServiceProviderSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"SpeechCredentialSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"credential successfully deleted","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"credential not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]}},"/ServiceProviders/{ServiceProviderSid}/SpeechCredentials/speech/supportedLanguagesAndVoices":{"get":{"operationId":"speech_supportedLanguagesAndVoices","summary":"get supported languages, voices and models","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["speech"],"parameters":[{"name":"ServiceProviderSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"vendor","in":"query","required":true,"schema":{"type":"string"}},{"name":"label","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"get supported languages, voices and models","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeechLanguagesVoices"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/ServiceProviders/{ServiceProviderSid}/SpeechCredentials/{SpeechCredentialSid}/test":{"get":{"operationId":"speech_testSpeechCredential","summary":"test a speech credential","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["speech"],"parameters":[{"name":"ServiceProviderSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"SpeechCredentialSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"credential test results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Speech_testSpeechCredential_Response_200"}}}},"404":{"description":"credential not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/PhoneNumbers":{"get":{"operationId":"phoneNumbers_listProvisionedPhoneNumbers","summary":"list phone numbers","tags":["phoneNumbers"],"responses":{"200":{"description":"list of phone numbers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"}}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"phoneNumbers_provisionPhoneNumber","summary":"provision a phone number into inventory from a Voip Carrier","tags":["phoneNumbers"],"responses":{"201":{"description":"phone number successfully provisioned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulAdd"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"404":{"description":"voip carrier not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"account_sid":{"type":"string","format":"uuid"},"application_sid":{"type":"string","format":"uuid"},"number":{"type":"string","description":"telephone number"},"voip_carrier_sid":{"type":"string","format":"uuid"}},"required":["number","voip_carrier_sid"]}}}},"security":[{"bearerAuth":[]}]}},"/PhoneNumbers/{PhoneNumberSid}":{"get":{"operationId":"phoneNumbers_getPhoneNumber","summary":"retrieve phone number","tags":["phoneNumbers"],"parameters":[{"name":"PhoneNumberSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"phone number found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumber"}}}},"404":{"description":"phone number not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"phoneNumbers_updatePhoneNumber","summary":"update phone number","tags":["phoneNumbers"],"parameters":[{"name":"PhoneNumberSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"phone number updated","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"404":{"description":"phone number not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumber"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"phoneNumbers_deletePhoneNumber","summary":"delete a phone number","tags":["phoneNumbers"],"parameters":[{"name":"PhoneNumberSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"phone number successfully deleted","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"phone number not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/Lcrs":{"get":{"operationId":"callRouting_listLeastCostRoutings","summary":"list least cost routings","tags":["callRouting"],"responses":{"200":{"description":"list of least cost routings","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Lcr"}}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"callRouting_createLcr","summary":"create a Least Cost Routing","tags":["callRouting"],"responses":{"201":{"description":"Least Cost Routing successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulAdd"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"name or Least Cost Routing"}},"required":["name"]}}}},"security":[{"bearerAuth":[]}]}},"/Lcrs/{LcrSid}":{"get":{"operationId":"callRouting_getLeastCostRouting","summary":"retrieve least cost routing","tags":["callRouting"],"parameters":[{"name":"LcrSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"least cost routing found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lcr"}}}},"404":{"description":"least cost routing not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"callRouting_updateLeastCostRouting","summary":"update least cost routing","tags":["callRouting"],"parameters":[{"name":"LcrSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"least cost routing updated","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"404":{"description":"least cost routing not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lcr"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"callRouting_deleteLeastCostRouting","summary":"delete a least cost routing","tags":["callRouting"],"parameters":[{"name":"LcrSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"least cost routing successfully deleted","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"least cost routing not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/Lcrs/{LcrSid}/Routes":{"post":{"operationId":"callRouting_createLeastCostRoutingRoutesAndCarrierEntries","summary":"Create least cost routing routes and carrier set entries","tags":["callRouting"],"parameters":[{"name":"LcrSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"least cost routing routes and carrier set entries created","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"404":{"description":"least cost routing not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LcrRoutes"}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"callRouting_updateLeastCostRoutingRoutesAndCarrierEntries","summary":"update least cost routing routes and carrier set entries","tags":["callRouting"],"parameters":[{"name":"LcrSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"least cost routing ruoutes and carrier entries updated","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"404":{"description":"least cost routing not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LcrRoutes"}}}},"security":[{"bearerAuth":[]}]}},"/LcrRoutes":{"get":{"operationId":"callRouting_listLeastCostRoutingRoutes","summary":"list least cost routings routes","tags":["callRouting"],"parameters":[{"name":"lcr_sid","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"list of least cost routing routes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LcrRoute"}}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"callRouting_createLcrRoutes","summary":"create a Least Cost Routing Routes","tags":["callRouting"],"responses":{"201":{"description":"Least Cost Routing Route successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulAdd"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LcrRoute"}}}}},"security":[{"bearerAuth":[]}]}},"/LcrRoutes/{LcrRouteSid}":{"get":{"operationId":"callRouting_getLeastCostRoutingRoute","summary":"retrieve least cost routing route","tags":["callRouting"],"parameters":[{"name":"LcrRouteSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"least cost routing route found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LcrRoute"}}}},"404":{"description":"least cost routing route not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"callRouting_updateLeastCostRoutingRoute","summary":"update least cost routing route","tags":["callRouting"],"parameters":[{"name":"LcrRouteSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"least cost routing route updated","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"404":{"description":"least cost routing route not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LcrRoute"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"callRouting_deleteLeastCostRoutingRoute","summary":"delete a least cost routing route","tags":["callRouting"],"parameters":[{"name":"LcrRouteSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"least cost routing route successfully deleted","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"least cost routing route not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/LcrCarrierSetEntries":{"get":{"operationId":"callRouting_listLeastCostRoutingCarrierSetEntries","summary":"list least cost routings routes","tags":["callRouting"],"responses":{"200":{"description":"list of least cost routing carrier set entries","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LcrCarrierSetEntry"}}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"callRouting_createLcrCarrierSetEntry","summary":"create a Least Cost Routing Carrier Set Entry","tags":["callRouting"],"responses":{"201":{"description":"Least Cost Routing Carrier Set Entry successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulAdd"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LcrCarrierSetEntry"}}}}},"security":[{"bearerAuth":[]}]}},"/LcrCarrierSetEntries/{LcrCarrierSetEntrySid}":{"get":{"operationId":"callRouting_getLeastCostRoutingCarrierSetEntry","summary":"retrieve least cost routing carrier set entry","tags":["callRouting"],"parameters":[{"name":"LcrCarrierSetEntrySid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"least cost routing carrier set entry found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LcrCarrierSetEntry"}}}},"404":{"description":"least cost routing carrier set entry not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"callRouting_updateLeastCostRoutingCarrierSetEntry","summary":"update least cost routing carrier set entry","tags":["callRouting"],"parameters":[{"name":"LcrCarrierSetEntrySid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"least cost routing carrier set entry updated","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"404":{"description":"least cost routing carrier set entry not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LcrCarrierSetEntry"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"callRouting_deleteLeastCostRoutingCarrierSetEntry","summary":"delete a least cost routing carrier set entry","tags":["callRouting"],"parameters":[{"name":"LcrCarrierSetEntrySid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"least cost routing carrier set entry successfully deleted","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"least cost routing carrier set entry not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/ServiceProviders/{ServiceProviderSid}/Lcrs":{"get":{"operationId":"callRouting_getServiceProviderLcrs","summary":"get all Least Cost Routings for a service provider","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["callRouting"],"parameters":[{"name":"ServiceProviderSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Least cost routing listing","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Lcr"}}}}},"403":{"description":"unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"service provider not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"callRouting_createLcrForServiceProvider","summary":"create a Lest cost routing for a service provider","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["callRouting"],"parameters":[{"name":"ServiceProviderSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"201":{"description":"service provider Lcr successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulAdd"}}}},"404":{"description":"service provider not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"name or Least Cost Routing"}},"required":["name"]}}}},"security":[{"bearerAuth":[]}]}},"/ServiceProviders":{"get":{"operationId":"serviceProviders_listServiceProviders","summary":"list service providers","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["serviceProviders"],"responses":{"200":{"description":"list of service providers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServiceProvider"}}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"serviceProviders_createServiceProvider","summary":"create service provider","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["serviceProviders"],"responses":{"201":{"description":"service provider successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulAdd"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"service provider name"},"description":{"type":"string"},"root_domain":{"type":"string","description":"root domain for group of accounts that share a registration hook"},"registration_hook":{"$ref":"#/components/schemas/Webhook","description":"authentication webhook for registration"},"ms_teams_fqdn":{"type":"string","description":"SBC domain name for Microsoft Teams"}},"required":["name"]}}}},"security":[{"bearerAuth":[]}]}},"/ServiceProviders/{ServiceProviderSid}":{"get":{"operationId":"serviceProviders_getServiceProvider","summary":"retrieve service provider","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["serviceProviders"],"parameters":[{"name":"ServiceProviderSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"service provider found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceProvider"}}}},"404":{"description":"service provider not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"serviceProviders_updateServiceProvider","summary":"update service provider","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["serviceProviders"],"parameters":[{"name":"ServiceProviderSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"service provider updated","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"service provider not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceProvider"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"serviceProviders_deleteServiceProvider","summary":"delete a service provider","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["serviceProviders"],"parameters":[{"name":"ServiceProviderSid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"service provider successfully deleted","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"service provider not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]}},"/ServiceProviders/{ServiceProviderSid}/Accounts":{"get":{"operationId":"serviceProviders_getServiceProviderAccounts","summary":"get all accounts for a service provider","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["serviceProviders"],"parameters":[{"name":"ServiceProviderSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"account listing","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Account"}}}}},"403":{"description":"unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"service provider not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"bearerAuth":[]}]}},"/ServiceProviders/{ServiceProviderSid}/Limits":{"get":{"operationId":"serviceProviders_getServiceProviderLimits","summary":"retrieve call capacity and other limits from the service provider","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["serviceProviders"],"parameters":[{"name":"ServiceProviderSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"service provider limits","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Limits"}}}}},"404":{"description":"service provider not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"serviceProviders_addLimitForServiceProvider","summary":"create a limit for a service provider","description":"<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>","tags":["serviceProviders"],"parameters":[{"name":"ServiceProviderSid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"201":{"description":"limit successfully created or updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulAdd"}}}},"404":{"description":"service provider not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"system error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Limits"}}}},"security":[{"bearerAuth":[]}]}}},"tags":[{"name":"users"},{"name":"settings"},{"name":"accounts"},{"name":"clients"},{"name":"applications"},{"name":"recentCalls"},{"name":"alerts"},{"name":"carriers"},{"name":"speech"},{"name":"phoneNumbers"},{"name":"callRouting"},{"name":"serviceProviders"}],"servers":[{"url":"https://api.jambonz.cloud/v1","description":"https://api.jambonz.cloud/v1"}],"components":{"schemas":{"Users_createUser_Response_200":{"type":"object","properties":{"user_sid":{"type":"string","format":"uuid","description":"The sid of the newly created user"}},"title":"Users_createUser_Response_200"},"GeneralError":{"type":"object","properties":{"msg":{"type":"string"}},"required":["msg"],"title":"GeneralError"},"UsersUserSidGetResponsesContentApplicationJsonSchemaIsActive":{"type":"string","enum":["0","1"],"description":"user account is active","title":"UsersUserSidGetResponsesContentApplicationJsonSchemaIsActive"},"UsersUserSidGetResponsesContentApplicationJsonSchemaForceChange":{"type":"string","enum":["0","1"],"description":"require the user to change password on next login","title":"UsersUserSidGetResponsesContentApplicationJsonSchemaForceChange"},"UsersUserSidGetResponsesContentApplicationJsonSchemaProvider":{"type":"string","enum":["local"],"title":"UsersUserSidGetResponsesContentApplicationJsonSchemaProvider"},"UsersUserSidGetResponsesContentApplicationJsonSchemaScope":{"type":"string","enum":["read-write"],"title":"UsersUserSidGetResponsesContentApplicationJsonSchemaScope"},"UsersUserSidGetResponsesContentApplicationJsonSchemaEmailValidated":{"type":"string","enum":["0","1"],"title":"UsersUserSidGetResponsesContentApplicationJsonSchemaEmailValidated"},"UsersUserSidGetResponsesContentApplicationJsonSchemaPhoneValidated":{"type":"string","enum":["0","1"],"title":"UsersUserSidGetResponsesContentApplicationJsonSchemaPhoneValidated"},"UsersUserSidGetResponsesContentApplicationJsonSchemaEmailContentOptOut":{"type":"string","enum":["0","1"],"title":"UsersUserSidGetResponsesContentApplicationJsonSchemaEmailContentOptOut"},"Users_getUser_Response_200":{"type":"object","properties":{"user_sid":{"type":"string","format":"uuid"},"name":{"type":"string","description":"username"},"email":{"type":"string","description":"user email address"},"is_active":{"$ref":"#/components/schemas/UsersUserSidGetResponsesContentApplicationJsonSchemaIsActive","description":"user account is active"},"force_change":{"$ref":"#/components/schemas/UsersUserSidGetResponsesContentApplicationJsonSchemaForceChange","description":"require the user to change password on next login"},"account_sid":{"type":"string","format":"uuid","description":"account sid the account the user will have access to, if not set will create a Service Provider account"},"service_provider_sid":{"type":"string","format":"uuid","description":"The service provider sid, the account is under, if not set account will be admin level"},"is_view_only":{"type":"boolean","description":"If set to true the user will not be able to make changes"},"provider":{"$ref":"#/components/schemas/UsersUserSidGetResponsesContentApplicationJsonSchemaProvider"},"provider_user_id":{"type":"string"},"scope":{"$ref":"#/components/schemas/UsersUserSidGetResponsesContentApplicationJsonSchemaScope"},"phone_activation_code":{"type":"string"},"email_activation_code":{"type":"string"},"email_validated":{"$ref":"#/components/schemas/UsersUserSidGetResponsesContentApplicationJsonSchemaEmailValidated"},"phone_validated":{"$ref":"#/components/schemas/UsersUserSidGetResponsesContentApplicationJsonSchemaPhoneValidated"},"email_content_opt_out":{"$ref":"#/components/schemas/UsersUserSidGetResponsesContentApplicationJsonSchemaEmailContentOptOut"},"pending_email":{"type":"string"},"phone":{"type":"string"}},"title":"Users_getUser_Response_200"},"MsTeamsTenant":{"type":"object","properties":{"service_provider_sid":{"type":"string","format":"uuid"},"account_sid":{"type":"string","format":"uuid"},"application_sid":{"type":"string","format":"uuid"},"tenant_fqdn":{"type":"string"}},"required":["service_provider_sid","tenant_fqdn"],"title":"MsTeamsTenant"},"SuccessfulAdd":{"type":"object","properties":{"sid":{"type":"string"}},"required":["sid"],"title":"SuccessfulAdd"},"AvailabilityGetParametersType":{"type":"string","enum":["email","phone","subdomain"],"title":"AvailabilityGetParametersType"},"Accounts_checkAvailability_Response_200":{"type":"object","properties":{"available":{"type":"boolean","description":"true if value requested is available"}},"required":["available"],"title":"Accounts_checkAvailability_Response_200"},"WebhookMethod":{"type":"string","enum":["get","post"],"title":"WebhookMethod"},"Webhook":{"type":"object","properties":{"webhook_sid":{"type":"string","format":"uuid"},"url":{"type":"string","format":"url"},"method":{"$ref":"#/components/schemas/WebhookMethod"},"username":{"type":"string"},"password":{"type":"string"}},"required":["url"],"title":"Webhook"},"AccountRecordFormat":{"type":"string","enum":["wav","mp3"],"title":"AccountRecordFormat"},"AccountBucketCredentialVendor":{"type":"string","enum":["aws_s3","s3_compatible","azure","google"],"title":"AccountBucketCredentialVendor"},"AccountBucketCredential":{"type":"object","properties":{"vendor":{"$ref":"#/components/schemas/AccountBucketCredentialVendor"},"region":{"type":"string"},"name":{"type":"string","description":"name of the bucket"},"access_key_id":{"type":"string"},"secret_access_key":{"type":"string"}},"description":"Credentials for recording storage","title":"AccountBucketCredential"},"Account":{"type":"object","properties":{"account_sid":{"type":"string","format":"uuid"},"name":{"type":"string"},"sip_realm":{"type":"string"},"registration_hook":{"$ref":"#/components/schemas/Webhook","description":"authentication webhook for registration"},"device_calling_application_sid":{"type":"string","format":"uuid"},"service_provider_sid":{"type":"string","format":"uuid"},"record_all_calls":{"type":"boolean"},"record_format":{"$ref":"#/components/schemas/AccountRecordFormat"},"bucket_credential":{"$ref":"#/components/schemas/AccountBucketCredential","description":"Credentials for recording storage"}},"required":["account_sid","name","service_provider_sid"],"title":"Account"},"Accounts_getWebhookSecret_Response_200":{"type":"object","properties":{"webhook_secret":{"type":"string"}},"title":"Accounts_getWebhookSecret_Response_200"},"LimitsCategory":{"type":"string","enum":["voice_call_session","api_limit","devices"],"title":"LimitsCategory"},"Limits":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/LimitsCategory"}},"title":"Limits"},"ApiKey":{"type":"object","properties":{"api_key_sid":{"type":"string","format":"uuid"},"token":{"type":"string","format":"uuid"},"account_sid":{"type":"string","format":"uuid"},"service_provider_sid":{"type":"string","format":"uuid"},"expires_at":{"type":"string","format":"date-time"},"created_at":{"type":"string","format":"date-time"},"last_used":{"type":"string","format":"date-time"}},"required":["api_key_sid","token"],"title":"ApiKey"},"Accounts_createApiKey_Response_200":{"type":"object","properties":{"sid":{"type":"string","format":"uuid"},"token":{"type":"string","format":"uuid"}},"title":"Accounts_createApiKey_Response_200"},"RegisteredClientProtocol":{"type":"string","enum":["wss","udp","tcp","tls"],"title":"RegisteredClientProtocol"},"RegisteredClientRegisteredStatus":{"type":"string","enum":["active","inactive"],"description":"if there is a current registered session from the client","title":"RegisteredClientRegisteredStatus"},"RegisteredClient":{"type":"object","properties":{"name":{"type":"string","description":"the client username"},"contact":{"type":"string","description":"The value in the contact header of the registration"},"expiryTime":{"type":"integer","description":"The timestamp (in ms since 00:00:00.000 01/01/1970) that the current registraion will expire"},"protocol":{"$ref":"#/components/schemas/RegisteredClientProtocol"},"allow_direct_app_calling":{"type":"integer","description":"set to 1 if client is allowed to call app sids directly"},"allow_direct_queue_calling":{"type":"integer","description":"set to 1 if client is allowed to dial into queues to dequeue calls"},"allow_direct_user_calling":{"type":"integer","description":"set to 1 if client is allowed to call other users by name directly."},"registered_status":{"$ref":"#/components/schemas/RegisteredClientRegisteredStatus","description":"if there is a current registered session from the client"},"proxy":{"type":"string","description":"The source IP and Port used for the registration request."}},"title":"RegisteredClient"},"ClientsGetResponsesContentApplicationJsonSchemaItemsIsActive":{"type":"string","enum":["1","0"],"title":"ClientsGetResponsesContentApplicationJsonSchemaItemsIsActive"},"ClientsGetResponsesContentApplicationJsonSchemaItemsAllowDirectAppCalling":{"type":"string","enum":["1","0"],"title":"ClientsGetResponsesContentApplicationJsonSchemaItemsAllowDirectAppCalling"},"ClientsGetResponsesContentApplicationJsonSchemaItemsAllowDirectQueueCalling":{"type":"string","enum":["1","0"],"title":"ClientsGetResponsesContentApplicationJsonSchemaItemsAllowDirectQueueCalling"},"ClientsGetResponsesContentApplicationJsonSchemaItemsAllowDirectUserCalling":{"type":"string","enum":["1","0"],"title":"ClientsGetResponsesContentApplicationJsonSchemaItemsAllowDirectUserCalling"},"ClientsGetResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"account_sid":{"type":"string","format":"uuid"},"client_sid":{"type":"string","format":"uuid"},"username":{"type":"string"},"password":{"type":"string","description":"in the response the password will only show the first character with subsequnet ones replaces by an x"},"is_active":{"$ref":"#/components/schemas/ClientsGetResponsesContentApplicationJsonSchemaItemsIsActive","default":1},"allow_direct_app_calling":{"$ref":"#/components/schemas/ClientsGetResponsesContentApplicationJsonSchemaItemsAllowDirectAppCalling","default":1},"allow_direct_queue_calling":{"$ref":"#/components/schemas/ClientsGetResponsesContentApplicationJsonSchemaItemsAllowDirectQueueCalling","default":1},"allow_direct_user_calling":{"$ref":"#/components/schemas/ClientsGetResponsesContentApplicationJsonSchemaItemsAllowDirectUserCalling","default":1}},"title":"ClientsGetResponsesContentApplicationJsonSchemaItems"},"ClientsPostRequestBodyContentApplicationJsonSchemaIsActive":{"type":"string","enum":["1","0"],"title":"ClientsPostRequestBodyContentApplicationJsonSchemaIsActive"},"ClientsPostRequestBodyContentApplicationJsonSchemaAllowDirectAppCalling":{"type":"string","enum":["1","0"],"title":"ClientsPostRequestBodyContentApplicationJsonSchemaAllowDirectAppCalling"},"ClientsPostRequestBodyContentApplicationJsonSchemaAllowDirectQueueCalling":{"type":"string","enum":["1","0"],"title":"ClientsPostRequestBodyContentApplicationJsonSchemaAllowDirectQueueCalling"},"ClientsPostRequestBodyContentApplicationJsonSchemaAllowDirectUserCalling":{"type":"string","enum":["1","0"],"title":"ClientsPostRequestBodyContentApplicationJsonSchemaAllowDirectUserCalling"},"Clients_createClient_Response_201":{"type":"object","properties":{"sid":{"type":"string","format":"uuid"}},"title":"Clients_createClient_Response_201"},"CreateClientRequestBadRequestError":{"type":"object","properties":{"msg":{"type":"string","format":"text"}},"title":"CreateClientRequestBadRequestError"},"ClientsClientSidGetResponsesContentApplicationJsonSchemaIsActive":{"type":"string","enum":["1","0"],"title":"ClientsClientSidGetResponsesContentApplicationJsonSchemaIsActive"},"ClientsClientSidGetResponsesContentApplicationJsonSchemaAllowDirectAppCalling":{"type":"string","enum":["1","0"],"title":"ClientsClientSidGetResponsesContentApplicationJsonSchemaAllowDirectAppCalling"},"ClientsClientSidGetResponsesContentApplicationJsonSchemaAllowDirectQueueCalling":{"type":"string","enum":["1","0"],"title":"ClientsClientSidGetResponsesContentApplicationJsonSchemaAllowDirectQueueCalling"},"ClientsClientSidGetResponsesContentApplicationJsonSchemaAllowDirectUserCalling":{"type":"string","enum":["1","0"],"title":"ClientsClientSidGetResponsesContentApplicationJsonSchemaAllowDirectUserCalling"},"Clients_getClient_Response_200":{"type":"object","properties":{"account_sid":{"type":"string","format":"uuid"},"client_sid":{"type":"string","format":"uuid"},"username":{"type":"string"},"password":{"type":"string","description":"in the response the password will only show the first character with subsequnet ones replaces by an x"},"is_active":{"$ref":"#/components/schemas/ClientsClientSidGetResponsesContentApplicationJsonSchemaIsActive","default":1},"allow_direct_app_calling":{"$ref":"#/components/schemas/ClientsClientSidGetResponsesContentApplicationJsonSchemaAllowDirectAppCalling","default":1},"allow_direct_queue_calling":{"$ref":"#/components/schemas/ClientsClientSidGetResponsesContentApplicationJsonSchemaAllowDirectQueueCalling","default":1},"allow_direct_user_calling":{"$ref":"#/components/schemas/ClientsClientSidGetResponsesContentApplicationJsonSchemaAllowDirectUserCalling","default":1}},"title":"Clients_getClient_Response_200"},"ClientsClientSidPutRequestBodyContentApplicationJsonSchemaIsActive":{"type":"string","enum":["1","0"],"title":"ClientsClientSidPutRequestBodyContentApplicationJsonSchemaIsActive"},"ClientsClientSidPutRequestBodyContentApplicationJsonSchemaAllowDirectAppCalling":{"type":"string","enum":["1","0"],"title":"ClientsClientSidPutRequestBodyContentApplicationJsonSchemaAllowDirectAppCalling"},"ClientsClientSidPutRequestBodyContentApplicationJsonSchemaAllowDirectQueueCalling":{"type":"string","enum":["1","0"],"title":"ClientsClientSidPutRequestBodyContentApplicationJsonSchemaAllowDirectQueueCalling"},"ClientsClientSidPutRequestBodyContentApplicationJsonSchemaAllowDirectUserCalling":{"type":"string","enum":["1","0"],"title":"ClientsClientSidPutRequestBodyContentApplicationJsonSchemaAllowDirectUserCalling"},"ApplicationEnvVars":{"type":"object","properties":{},"description":"Object containing the Application Environment Variables as key/value to be sent with the call_hook payload","title":"ApplicationEnvVars"},"Application":{"type":"object","properties":{"application_sid":{"type":"string","format":"uuid"},"name":{"type":"string"},"account_sid":{"type":"string","format":"uuid"},"call_hook":{"$ref":"#/components/schemas/Webhook","description":"application webhook for inbound voice calls"},"call_status_hook":{"$ref":"#/components/schemas/Webhook","description":"webhhok for reporting call status events"},"messaging_hook":{"$ref":"#/components/schemas/Webhook","description":"application webhook for inbound SMS/MMS"},"speech_synthesis_vendor":{"type":"string"},"speech_synthesis_voice":{"type":"string"},"speech_recognizer_vendor":{"type":"string"},"speech_recognizer_language":{"type":"string"},"env_vars":{"$ref":"#/components/schemas/ApplicationEnvVars","description":"Object containing the Application Environment Variables as key/value to be sent with the call_hook payload"},"record_all_calls":{"type":"boolean"}},"required":["name","account_sid"],"title":"Application"},"ApplicationsPostRequestBodyContentApplicationJsonSchemaEnvVars":{"type":"object","properties":{},"description":"Object containing the Application Environment Variables as key/value to be sent with the call_hook payload","title":"ApplicationsPostRequestBodyContentApplicationJsonSchemaEnvVars"},"Applications_getAppEnvSchema_Response_200":{"type":"object","properties":{},"title":"Applications_getAppEnvSchema_Response_200"},"AccountsAccountSidRecentCallsGetParametersAnswered":{"type":"string","enum":["true","false"],"description":"retrieve only answered calls","title":"AccountsAccountSidRecentCallsGetParametersAnswered"},"AccountsAccountSidRecentCallsGetParametersDirection":{"type":"string","enum":["inbound","outbound"],"title":"AccountsAccountSidRecentCallsGetParametersDirection"},"AccountsAccountSidRecentCallsGetResponsesContentApplicationJsonSchemaDataItemsDirection":{"type":"string","enum":["inbound","outbound"],"title":"AccountsAccountSidRecentCallsGetResponsesContentApplicationJsonSchemaDataItemsDirection"},"AccountsAccountSidRecentCallsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"account_sid":{"type":"string","format":"uuid"},"call_sid":{"type":"string","format":"uuid"},"from":{"type":"string"},"to":{"type":"string"},"answered":{"type":"boolean"},"sip_call_id":{"type":"string"},"sip_status":{"type":"integer"},"duration":{"type":"integer"},"attempted_at":{"type":"integer"},"answered_at":{"type":"integer"},"terminated_at":{"type":"integer"},"termination_reason":{"type":"string"},"host":{"type":"string"},"remote_host":{"type":"string"},"direction":{"$ref":"#/components/schemas/AccountsAccountSidRecentCallsGetResponsesContentApplicationJsonSchemaDataItemsDirection"},"trunk":{"type":"string"}},"required":["account_sid","call_sid","from","to","answered","sip_status","duration","attempted_at","terminated_at","direction"],"title":"AccountsAccountSidRecentCallsGetResponsesContentApplicationJsonSchemaDataItems"},"Recent_Calls_listRecentCalls_Response_200":{"type":"object","properties":{"total":{"type":"integer","description":"total number of records in that database that match the filter criteria"},"batch":{"type":"integer","description":"total number of records returned in this page set"},"page":{"type":"integer","description":"page number that was requested, and is being returned"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AccountsAccountSidRecentCallsGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"Recent Calls_listRecentCalls_Response_200"},"Recent_Calls_getRecentCallTrace_Response_200":{"type":"object","properties":{},"title":"Recent Calls_getRecentCallTrace_Response_200"},"AccountsAccountSidRecentCallsCallSidRecordYyyyMmDdFormatGetParametersFormat":{"type":"string","enum":["wav","mp3"],"title":"AccountsAccountSidRecentCallsCallSidRecordYyyyMmDdFormatGetParametersFormat"},"Recent_Calls_getRecentCallRecording_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Recent Calls_getRecentCallRecording_Response_200"},"Recent_Calls_getRecentCallTraceByAccount_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Recent Calls_getRecentCallTraceByAccount_Response_200"},"Recent_Calls_getRecentCallTraceBySP_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Recent Calls_getRecentCallTraceBySP_Response_200"},"ServiceProvidersServiceProviderSidRecentCallsGetParametersAnswered":{"type":"string","enum":["true","false"],"description":"retrieve only answered calls","title":"ServiceProvidersServiceProviderSidRecentCallsGetParametersAnswered"},"ServiceProvidersServiceProviderSidRecentCallsGetParametersDirection":{"type":"string","enum":["inbound","outbound"],"title":"ServiceProvidersServiceProviderSidRecentCallsGetParametersDirection"},"ServiceProvidersServiceProviderSidRecentCallsGetResponsesContentApplicationJsonSchemaDataItemsDirection":{"type":"string","enum":["inbound","outbound"],"title":"ServiceProvidersServiceProviderSidRecentCallsGetResponsesContentApplicationJsonSchemaDataItemsDirection"},"ServiceProvidersServiceProviderSidRecentCallsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"service_provider_sid":{"type":"string","format":"uuid"},"account_sid":{"type":"string","format":"uuid"},"call_sid":{"type":"string","format":"uuid"},"from":{"type":"string"},"to":{"type":"string"},"answered":{"type":"boolean"},"sip_call_id":{"type":"string"},"sip_status":{"type":"integer"},"duration":{"type":"integer"},"attempted_at":{"type":"integer"},"answered_at":{"type":"integer"},"terminated_at":{"type":"integer"},"termination_reason":{"type":"string"},"host":{"type":"string"},"remote_host":{"type":"string"},"direction":{"$ref":"#/components/schemas/ServiceProvidersServiceProviderSidRecentCallsGetResponsesContentApplicationJsonSchemaDataItemsDirection"},"trunk":{"type":"string"}},"required":["account_sid","call_sid","from","to","answered","sip_status","duration","attempted_at","terminated_at","direction"],"title":"ServiceProvidersServiceProviderSidRecentCallsGetResponsesContentApplicationJsonSchemaDataItems"},"Recent_Calls_listRecentCallsBySP_Response_200":{"type":"object","properties":{"total":{"type":"integer","description":"total number of records in that database that match the filter criteria"},"batch":{"type":"integer","description":"total number of records returned in this page set"},"page":{"type":"integer","description":"page number that was requested, and is being returned"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ServiceProvidersServiceProviderSidRecentCallsGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"Recent Calls_listRecentCallsBySP_Response_200"},"Recent_Calls_getRecentCallTraceByCallId_Response_200":{"type":"object","properties":{},"title":"Recent Calls_getRecentCallTraceByCallId_Response_200"},"AccountsAccountSidAlertsGetParametersAlertType":{"type":"string","enum":["webhook-failure","webhook-connection-failure","webhook-auth-failure","no-tts","no-stt","tts-failure","stt-failure","no-carrier","call-limit","device-limit","api-limit"],"title":"AccountsAccountSidAlertsGetParametersAlertType"},"AccountsAccountSidAlertsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"time":{"type":"string","format":"date-time"},"account_sid":{"type":"string","format":"uuid"},"alert_type":{"type":"string"},"message":{"type":"string"},"detail":{"type":"string"}},"required":["time","account_sid","alert_type","message"],"title":"AccountsAccountSidAlertsGetResponsesContentApplicationJsonSchemaDataItems"},"Alerts_listAlertsByAccount_Response_200":{"type":"object","properties":{"total":{"type":"integer","description":"total number of records in that database that match the filter criteria"},"batch":{"type":"integer","description":"total number of records returned in this page set"},"page":{"type":"integer","description":"page number that was requested, and is being returned"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AccountsAccountSidAlertsGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"Alerts_listAlertsByAccount_Response_200"},"AlertHookType":{"type":"string","enum":["json","slack","pagerduty","email"],"description":"json - signed JSON POST to a URL; slack - Slack incoming webhook; pagerduty - PagerDuty Events API v2; email - only when the platform has email configured","title":"AlertHookType"},"AlertHook":{"type":"object","properties":{"alert_hook_sid":{"type":"string","format":"uuid"},"account_sid":{"type":"string","format":"uuid"},"type":{"$ref":"#/components/schemas/AlertHookType"},"address":{"type":"string"},"created_at":{"type":"string","format":"date-time"}},"required":["alert_hook_sid","account_sid","type","address"],"title":"AlertHook"},"AlertHookTestResult":{"type":"object","properties":{"alert_hook_sid":{"type":"string","format":"uuid"},"type":{"$ref":"#/components/schemas/AlertHookType"},"ok":{"type":"boolean","description":"true if the destination accepted the test alert"},"status":{"type":"integer","description":"HTTP status returned by the destination, when there was one"},"error":{"type":"string","description":"error detail when ok is false"}},"required":["type","ok"],"title":"AlertHookTestResult"},"Alerts_testAlertHooks_Response_200":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/AlertHookTestResult"}}},"title":"Alerts_testAlertHooks_Response_200"},"Alerts_getAlertHookCapabilities_Response_200":{"type":"object","properties":{"email":{"type":"boolean","description":"true when email delivery is configured on the platform"}},"title":"Alerts_getAlertHookCapabilities_Response_200"},"SbcsGetResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"ipv4":{"type":"string","description":"ip address of one of our Sbcs"}},"required":["ipv4"],"title":"SbcsGetResponsesContentApplicationJsonSchemaItems"},"VoipCarrierTrunkType":{"type":"string","enum":["static_ip","auth","reg"],"default":"static_ip","description":"The type of trunk to create, see the [guide](/guides/using-the-jambonz-portal/basic-concepts/creating-carriers) for details","title":"VoipCarrierTrunkType"},"VoipCarrier":{"type":"object","properties":{"service_provider_sid":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string"},"account_sid":{"type":"string","format":"uuid"},"application_sid":{"type":"string","format":"uuid"},"e164_leading_plus":{"type":"boolean"},"requires_register":{"type":"boolean"},"register_username":{"type":"string"},"register_sip_realm":{"type":"string"},"register_password":{"type":"string"},"tech_prefix":{"type":"string"},"diversion":{"type":"string"},"is_active":{"type":"boolean"},"smpp_system_id":{"type":"string"},"smpp_password":{"type":"string"},"smpp_inbound_system_id":{"type":"string"},"smpp_inbound_password":{"type":"string"},"smpp_enquire_link_interval":{"type":"integer"},"trunk_type":{"$ref":"#/components/schemas/VoipCarrierTrunkType","default":"static_ip","description":"The type of trunk to create, see the [guide](/guides/using-the-jambonz-portal/basic-concepts/creating-carriers) for details"},"inbound_auth_username":{"type":"string","maxLength":64,"description":"username for an auth trunk"},"inbound_auth_password":{"type":"string","maxLength":64,"description":"password for an auth trunk"}},"required":["service_provider_sid","name"],"title":"VoipCarrier"},"SipGateway":{"type":"object","properties":{"sip_gateway_sid":{"type":"string","format":"uuid"},"ipv4":{"type":"string"},"port":{"type":"integer"},"netmask":{"type":"integer"},"voip_carrier_sid":{"type":"string","format":"uuid"},"inbound":{"type":"boolean"},"outbound":{"type":"boolean"}},"required":["sip_gateway_sid","ipv4","port","netmask","voip_carrier_sid"],"title":"SipGateway"},"AccountsAccountSidVoipCarriersGetResponsesContentApplicationJsonSchemaItemsTrunkType":{"type":"string","enum":["static_ip","auth","reg"],"default":"static_ip","description":"The type of trunk to create, see the [guide](/guides/using-the-jambonz-portal/basic-concepts/creating-carriers) for details","title":"AccountsAccountSidVoipCarriersGetResponsesContentApplicationJsonSchemaItemsTrunkType"},"AccountsAccountSidVoipCarriersGetResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"service_provider_sid":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string"},"account_sid":{"type":"string","format":"uuid"},"application_sid":{"type":"string","format":"uuid"},"e164_leading_plus":{"type":"boolean"},"requires_register":{"type":"boolean"},"register_username":{"type":"string"},"register_sip_realm":{"type":"string"},"register_password":{"type":"string"},"tech_prefix":{"type":"string"},"diversion":{"type":"string"},"is_active":{"type":"boolean"},"smpp_system_id":{"type":"string"},"smpp_password":{"type":"string"},"smpp_inbound_system_id":{"type":"string"},"smpp_inbound_password":{"type":"string"},"smpp_enquire_link_interval":{"type":"integer"},"trunk_type":{"$ref":"#/components/schemas/AccountsAccountSidVoipCarriersGetResponsesContentApplicationJsonSchemaItemsTrunkType","default":"static_ip","description":"The type of trunk to create, see the [guide](/guides/using-the-jambonz-portal/basic-concepts/creating-carriers) for details"},"inbound_auth_username":{"type":"string","maxLength":64,"description":"username for an auth trunk"},"inbound_auth_password":{"type":"string","maxLength":64,"description":"password for an auth trunk"},"voip_carrier_sid":{"type":"string","format":"uuid"}},"required":["service_provider_sid","name"],"title":"AccountsAccountSidVoipCarriersGetResponsesContentApplicationJsonSchemaItems"},"SpeechCredentialVendor":{"type":"string","enum":["google","aws"],"title":"SpeechCredentialVendor"},"SpeechCredential":{"type":"object","properties":{"speech_credential_sid":{"type":"string","format":"uuid"},"account_sid":{"type":"string","format":"uuid"},"vendor":{"$ref":"#/components/schemas/SpeechCredentialVendor"},"service_key":{"type":"string"},"access_key_id":{"type":"string"},"secret_access_key":{"type":"string"},"aws_region":{"type":"string"},"last_used":{"type":"string","format":"date-time"},"last_tested":{"type":"string","format":"date-time"},"use_for_tts":{"type":"boolean"},"use_for_stt":{"type":"boolean"},"tts_tested_ok":{"type":"boolean"},"stt_tested_ok":{"type":"boolean"},"riva_server_uri":{"type":"string"}},"title":"SpeechCredential"},"SpeechCredentialUpdate":{"type":"object","properties":{"use_for_tts":{"type":"boolean"},"use_for_stt":{"type":"boolean"}},"title":"SpeechCredentialUpdate"},"LanguageVoice":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}},"title":"LanguageVoice"},"LanguageVoices":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"voices":{"type":"array","items":{"$ref":"#/components/schemas/LanguageVoice"}}},"title":"LanguageVoices"},"TtsModel":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}},"title":"TtsModel"},"SpeechLanguagesVoices":{"type":"object","properties":{"tts":{"type":"array","items":{"$ref":"#/components/schemas/LanguageVoices"}},"stt":{"type":"array","items":{"$ref":"#/components/schemas/LanguageVoice"}},"ttsModel":{"type":"array","items":{"$ref":"#/components/schemas/TtsModel"}}},"title":"SpeechLanguagesVoices"},"AccountsAccountSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaTtsStatus":{"type":"string","enum":["success","fail","not tested"],"title":"AccountsAccountSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaTtsStatus"},"AccountsAccountSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaTts":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/AccountsAccountSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaTtsStatus"},"reason":{"type":"string"}},"title":"AccountsAccountSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaTts"},"AccountsAccountSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaSttStatus":{"type":"string","enum":["success","fail"],"title":"AccountsAccountSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaSttStatus"},"AccountsAccountSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaStt":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/AccountsAccountSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaSttStatus"},"reason":{"type":"string"}},"title":"AccountsAccountSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaStt"},"Speech_testSpeechCredentialByAccount_Response_200":{"type":"object","properties":{"tts":{"$ref":"#/components/schemas/AccountsAccountSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaTts"},"stt":{"$ref":"#/components/schemas/AccountsAccountSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaStt"}},"title":"Speech_testSpeechCredentialByAccount_Response_200"},"GoogleCustomVoice":{"type":"object","properties":{"speech_credential_sid":{"type":"string"},"name":{"type":"string"},"reported_usage":{"type":"string"},"model":{"type":"string"}},"required":["speech_credential_sid","name","reported_usage","model"],"title":"GoogleCustomVoice"},"ServiceProvidersServiceProviderSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaTtsStatus":{"type":"string","enum":["success","fail","not tested"],"title":"ServiceProvidersServiceProviderSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaTtsStatus"},"ServiceProvidersServiceProviderSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaTts":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/ServiceProvidersServiceProviderSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaTtsStatus"},"reason":{"type":"string"}},"title":"ServiceProvidersServiceProviderSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaTts"},"ServiceProvidersServiceProviderSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaSttStatus":{"type":"string","enum":["success","fail"],"title":"ServiceProvidersServiceProviderSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaSttStatus"},"ServiceProvidersServiceProviderSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaStt":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/ServiceProvidersServiceProviderSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaSttStatus"},"reason":{"type":"string"}},"title":"ServiceProvidersServiceProviderSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaStt"},"Speech_testSpeechCredential_Response_200":{"type":"object","properties":{"tts":{"$ref":"#/components/schemas/ServiceProvidersServiceProviderSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaTts"},"stt":{"$ref":"#/components/schemas/ServiceProvidersServiceProviderSidSpeechCredentialsSpeechCredentialSidTestGetResponsesContentApplicationJsonSchemaStt"}},"title":"Speech_testSpeechCredential_Response_200"},"PhoneNumber":{"type":"object","properties":{"phone_number_sid":{"type":"string","format":"uuid"},"number":{"type":"string"},"voip_carrier_sid":{"type":"string","format":"uuid"},"account_sid":{"type":"string","format":"uuid"},"application_sid":{"type":"string","format":"uuid"}},"required":["phone_number_sid","number","voip_carrier_sid"],"title":"PhoneNumber"},"Lcr":{"type":"object","properties":{"name":{"type":"string"},"default_carrier_set_entry_sid":{"type":"string"}},"required":["name"],"title":"Lcr"},"LcrCarrierSetEntry":{"type":"object","properties":{"workload":{"type":"integer","description":"traffic distribution value"},"lcr_route_sid":{"type":"string"},"voip_carrier_sid":{"type":"string"},"priority":{"type":"integer"}},"required":["lcr_route_sid","voip_carrier_sid","priority"],"title":"LcrCarrierSetEntry"},"LcrRouteAndCarrierEntries":{"type":"object","properties":{"lcr_sid":{"type":"string"},"regex":{"type":"string","description":"out going call Phone number regex"},"priority":{"type":"integer"},"description":{"type":"string"},"lcr_carrier_set_entries":{"type":"array","items":{"$ref":"#/components/schemas/LcrCarrierSetEntry"}}},"required":["lcr_sid","regex","priority"],"title":"LcrRouteAndCarrierEntries"},"LcrRoutes":{"type":"array","items":{"$ref":"#/components/schemas/LcrRouteAndCarrierEntries"},"title":"LcrRoutes"},"LcrRoute":{"type":"object","properties":{"lcr_sid":{"type":"string"},"regex":{"type":"string","description":"out going call Phone number regex"},"priority":{"type":"integer"},"description":{"type":"string"}},"required":["lcr_sid","regex","priority"],"title":"LcrRoute"},"ServiceProvider":{"type":"object","properties":{"service_provider_sid":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string"},"root_domain":{"type":"string"},"registration_hook":{"$ref":"#/components/schemas/Webhook","description":"authentication webhook for registration"},"ms_teams_fqdn":{"type":"string"},"test_number":{"type":"string","description":"used for inbound testing for accounts on free plan"},"test_application_name":{"type":"string","description":"name of test application that can be used for new signups"},"test_application_sid":{"type":"string","description":"identifies test application that can be used for new signups"}},"required":["service_provider_sid","name"],"title":"ServiceProvider"}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}}