{"items":[{"type":"link","label":"AVANSER Telco API","link":"/telco-api/references","routeSlug":"/telco-api/references","content":{"contentType":"overview","meta":{"name":"AVANSER Telco API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"references.json","url":"/_bundle/telco-api/references.json?download"},{"kind":"download","label":"references.yaml","url":"/_bundle/telco-api/references.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"AVANSER Telco API (202610)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"AVANSER Telco API is designed to provide an easy way to order and manage client services.\n\nAVANSER Telco API is Agency friendly. Users can be configured to have access to multiple AVANSER accounts, facilitating service automation."}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"group","label":"Accounts","link":"/telco-api/references/accounts","routeSlug":"/telco-api/references/accounts","items":[{"label":"List Accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/accounts/listaccounts","routeSlug":"/telco-api/references/accounts/listaccounts","metadata":{"seo":{"title":"List Accounts","description":"List all available accounts associated with the user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAccounts","name":"List Accounts","isWebhook":false,"pointer":"/paths/~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all available accounts associated with the user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_0","description":"Indicates whether the caller intends to use the account for configuration-related endpoints or billing-related endpoints.","example":"configuration"}],"pointer":"/paths/~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"type","in":"query","required":false,"example":"configuration","schemaId":"schema_0"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/accounts","href":"accounts/listaccounts","openApiOperationId":"listAccounts","summary":"List Accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Accounts"}},"schemaId":"components/schemas/Accounts"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1accounts/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1accounts/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts/get/responses/401/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Accounts","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Accounts"}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1accounts/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1accounts/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/listaccounts"}],"panels":[]}]},"httpPath":"/accounts"},{"label":"Switch Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/accounts/switchaccount","routeSlug":"/telco-api/references/accounts/switchaccount","metadata":{"seo":{"title":"Switch Account","description":"Switch between available accounts associated with the user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"switchAccount","name":"Switch Account","isWebhook":false,"pointer":"/paths/~1accounts/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Switch Account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Switch between available accounts associated with the user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"account-id","in":"query","schemaId":"schema_1","description":"Enter the desired account ID (client ID).","required":true}],"pointer":"/paths/~1accounts/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/accounts","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"account-id","in":"query","required":true,"schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/accounts","href":"accounts/switchaccount","openApiOperationId":"switchAccount","summary":"Switch Account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericSuccess"}},"schemaId":"components/schemas/GenericSuccess"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1accounts/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1accounts/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts/post/responses/401/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1accounts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GenericSuccess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericSuccess"}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1accounts/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1accounts/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts/post/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1accounts/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/switchaccount"}],"panels":[]}]},"httpPath":"/accounts"},{"label":"List Account Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/accounts/listaccountdetails","routeSlug":"/telco-api/references/accounts/listaccountdetails","metadata":{"seo":{"title":"List Account Details","description":"List details of selected account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAccountDetails","name":"List Account Details","isWebhook":false,"pointer":"/paths/~1accounts~1details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Account Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List details of selected account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/details","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/accounts/details","href":"accounts/listaccountdetails","openApiOperationId":"listAccountDetails","summary":"List Account Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/accountDetails"}},"schemaId":"components/schemas/accountDetails"}],"pointer":"/paths/~1accounts~1details/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/accountDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/accountDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/listaccountdetails"}],"panels":[]}]},"httpPath":"/accounts/details"},{"label":"List Account Packages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/accounts/listaccountpackages","routeSlug":"/telco-api/references/accounts/listaccountpackages","metadata":{"seo":{"title":"List Account Packages","description":"Lists all of the packages for the currently selected client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAccountPackages","name":"List Account Packages","isWebhook":false,"pointer":"/paths/~1accounts~1packages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Account Packages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all of the packages for the currently selected client."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/packages","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/accounts/packages","href":"accounts/listaccountpackages","openApiOperationId":"listAccountPackages","summary":"List Account Packages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/accountPackages"}},"schemaId":"components/schemas/accountPackages"}],"pointer":"/paths/~1accounts~1packages/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/accountPackages","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/accountPackages"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/listaccountpackages"}],"panels":[]}]},"httpPath":"/accounts/packages"},{"label":"List Number Rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/accounts/listnumberrates","routeSlug":"/telco-api/references/accounts/listnumberrates","metadata":{"seo":{"title":"List Number Rates","description":"Lists all of the number rates for the currently selected client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNumberRates","name":"List Number Rates","isWebhook":false,"pointer":"/paths/~1accounts~1number_rates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Number Rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all of the number rates for the currently selected client."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/number_rates","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/accounts/number_rates","href":"accounts/listnumberrates","openApiOperationId":"listNumberRates","summary":"List Number Rates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/accountNumberRates"}},"schemaId":"components/schemas/accountNumberRates"}],"pointer":"/paths/~1accounts~1number_rates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/accountNumberRates","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/accountNumberRates"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/listnumberrates"}],"panels":[]}]},"httpPath":"/accounts/number_rates"},{"label":"List Call Rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/accounts/listcallrates","routeSlug":"/telco-api/references/accounts/listcallrates","metadata":{"seo":{"title":"List Call Rates","description":"Lists all of the call rates for the currently selected client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCallRates","name":"List Call Rates","isWebhook":false,"pointer":"/paths/~1accounts~1call_rates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Call Rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all of the call rates for the currently selected client."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/call_rates","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/accounts/call_rates","href":"accounts/listcallrates","openApiOperationId":"listCallRates","summary":"List Call Rates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/accountCallRates"}},"schemaId":"components/schemas/accountCallRates"}],"pointer":"/paths/~1accounts~1call_rates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/accountCallRates","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/accountCallRates"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/listcallrates"}],"panels":[]}]},"httpPath":"/accounts/call_rates"},{"label":"List Transcription Rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/accounts/listtranscriptionrates","routeSlug":"/telco-api/references/accounts/listtranscriptionrates","metadata":{"seo":{"title":"List Transcription Rates","description":"Lists all of the transcription rates for the currently selected client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTranscriptionRates","name":"List Transcription Rates","isWebhook":false,"pointer":"/paths/~1accounts~1transcription_rates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Transcription Rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all of the transcription rates for the currently selected client."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/transcription_rates","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/accounts/transcription_rates","href":"accounts/listtranscriptionrates","openApiOperationId":"listTranscriptionRates","summary":"List Transcription Rates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/accountTranscriptionRates"}},"schemaId":"components/schemas/accountTranscriptionRates"}],"pointer":"/paths/~1accounts~1transcription_rates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/accountTranscriptionRates","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/accountTranscriptionRates"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/listtranscriptionrates"}],"panels":[]}]},"httpPath":"/accounts/transcription_rates"},{"label":"List Account Features","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/accounts/listaccountfeatures","routeSlug":"/telco-api/references/accounts/listaccountfeatures","metadata":{"seo":{"title":"List Account Features","description":"Lists all of the features for the currently selected client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAccountFeatures","name":"List Account Features","isWebhook":false,"pointer":"/paths/~1accounts~1features/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Account Features","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all of the features for the currently selected client."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/features","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/accounts/features","href":"accounts/listaccountfeatures","openApiOperationId":"listAccountFeatures","summary":"List Account Features"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/accountFeatures"}},"schemaId":"components/schemas/accountFeatures"}],"pointer":"/paths/~1accounts~1features/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/accountFeatures","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/accountFeatures"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/listaccountfeatures"}],"panels":[]}]},"httpPath":"/accounts/features"}],"content":{"contentType":"group","meta":{"name":"Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounts","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/accounts","summary":"List Accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/listaccounts","deprecated":false},{"title":"/accounts","summary":"Switch Account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/accounts/switchaccount","deprecated":false},{"title":"/accounts/details","summary":"List Account Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/listaccountdetails","deprecated":false},{"title":"/accounts/packages","summary":"List Account Packages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/listaccountpackages","deprecated":false},{"title":"/accounts/number_rates","summary":"List Number Rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/listnumberrates","deprecated":false},{"title":"/accounts/call_rates","summary":"List Call Rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/listcallrates","deprecated":false},{"title":"/accounts/transcription_rates","summary":"List Transcription Rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/listtranscriptionrates","deprecated":false},{"title":"/accounts/features","summary":"List Account Features","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/listaccountfeatures","deprecated":false}]}]}]}]}},{"type":"group","label":"Search Numbers","link":"/telco-api/references/search-numbers","routeSlug":"/telco-api/references/search-numbers","items":[{"label":"by Location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/search-numbers/searchnumbersbylocation","routeSlug":"/telco-api/references/search-numbers/searchnumbersbylocation","metadata":{"seo":{"title":"by Location","description":"Search for available numbers by location will return all available numbers within a provided radius from the search location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchNumbersByLocation","name":"by Location","isWebhook":false,"pointer":"/paths/~1numbers?country={country}&location={location}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"by Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for available numbers by location will return all available numbers within a provided radius from the search location."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"country","in":"path","schemaId":"schema_2","description":"Search country.","required":true},{"name":"location","in":"path","schemaId":"schema_2","description":"Search into AVANSER inventory by Address eg. \"Level 2 150-152 Elizabeth St, 2000 NSW, Australia\".","required":true}],"pointer":"/paths/~1numbers?country={country}&location={location}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"radius","in":"query","schemaId":"schema_3","description":"Search radius in kilometers."}],"pointer":"/paths/~1numbers?country={country}&location={location}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/numbers?country={country}&location={location}","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[{"name":"country","in":"path","required":true,"schemaId":"schema_2"},{"name":"location","in":"path","required":true,"schemaId":"schema_2"}],"query":[{"name":"radius","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","300","400","401","500"],"pointer":"/numbers?country={country}&location={location}","href":"search-numbers/searchnumbersbylocation","openApiOperationId":"searchNumbersByLocation","summary":"by Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchElement"}},"schemaId":"components/schemas/SearchElement"},{"code":"300","description":"Multiple addresses (by Location only)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MultipleAddresses"}},"schemaId":"components/schemas/MultipleAddresses"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail"}},"schemaId":"components/schemas/ErrorDetail"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&location={location}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&location={location}/get/responses/401/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&location={location}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&location={location}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1numbers?country={country}&location={location}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchElement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchElement"}}},{"code":"300","schemaId":"components/schemas/MultipleAddresses","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MultipleAddresses"}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&location={location}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&location={location}/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&location={location}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&location={location}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search-numbers/searchnumbersbylocation"}],"panels":[]}]},"httpPath":"/numbers?country={country}&location={location}"},{"label":"by Coordinates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/search-numbers/searchnumbersbycoordinates","routeSlug":"/telco-api/references/search-numbers/searchnumbersbycoordinates","metadata":{"seo":{"title":"by Coordinates","description":"Search for available numbers by latitude and longitude, will return all available number within the provided radius from the search coordinates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchNumbersByCoordinates","name":"by Coordinates","isWebhook":false,"pointer":"/paths/~1numbers?country={country}&lat={lat}&lng={lng}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"by Coordinates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for available numbers by latitude and longitude, will return all available number within the provided radius from the search coordinates."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"country","in":"path","schemaId":"schema_2","description":"Search country.","required":true},{"name":"lat","in":"path","schemaId":"schema_1","description":"Latitude","required":true},{"name":"lng","in":"path","schemaId":"schema_1","description":"Longitude","required":true}],"pointer":"/paths/~1numbers?country={country}&lat={lat}&lng={lng}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"radius","in":"query","schemaId":"schema_3","description":"Search radius in kilometers."}],"pointer":"/paths/~1numbers?country={country}&lat={lat}&lng={lng}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/numbers?country={country}&lat={lat}&lng={lng}","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[{"name":"country","in":"path","required":true,"schemaId":"schema_2"},{"name":"lat","in":"path","required":true,"schemaId":"schema_1"},{"name":"lng","in":"path","required":true,"schemaId":"schema_1"}],"query":[{"name":"radius","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/numbers?country={country}&lat={lat}&lng={lng}","href":"search-numbers/searchnumbersbycoordinates","openApiOperationId":"searchNumbersByCoordinates","summary":"by Coordinates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchElement"}},"schemaId":"components/schemas/SearchElement"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail"}},"schemaId":"components/schemas/ErrorDetail"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&lat={lat}&lng={lng}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&lat={lat}&lng={lng}/get/responses/401/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&lat={lat}&lng={lng}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&lat={lat}&lng={lng}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1numbers?country={country}&lat={lat}&lng={lng}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchElement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchElement"}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&lat={lat}&lng={lng}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&lat={lat}&lng={lng}/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&lat={lat}&lng={lng}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&lat={lat}&lng={lng}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search-numbers/searchnumbersbycoordinates"}],"panels":[]}]},"httpPath":"/numbers?country={country}&lat={lat}&lng={lng}"},{"label":"by Matching prefix","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/search-numbers/searchnumbersbymatchingprefix","routeSlug":"/telco-api/references/search-numbers/searchnumbersbymatchingprefix","metadata":{"seo":{"title":"by Matching prefix","description":"Search for available numbers matching provided number as close as possible."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchNumbersByMatchingPrefix","name":"by Matching prefix","isWebhook":false,"pointer":"/paths/~1numbers?country={country}&number={number}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"by Matching prefix","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search for available numbers matching provided number as close as possible."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checks are performed trying first to get a perfect match, than reducing the matching length by 1 up to 6 digits."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"search-numbers/searchnumbersbymatchingprefix/request/example:-matching-61290081596","deepLinkHash":"/search-numbers/searchnumbersbymatchingprefix#search-numbers/searchnumbersbymatchingprefix/request/example:-matching-61290081596"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: matching 61290081596"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attempt: matching 61290081596"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attempt: matching 6129008159X"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attempt: matching 612900815XX"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attempt: matching 61290081XXX"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attempt: matching 6129008XXXX"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attempt: matching 612900XXXXX"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attempt: matching 61290XXXXXX"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"country","in":"path","schemaId":"schema_2","description":"Search country.","required":true},{"name":"number","in":"path","schemaId":"schema_2","description":"Valid phone number (E164 format)","required":true}],"pointer":"/paths/~1numbers?country={country}&number={number}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/numbers?country={country}&number={number}","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[{"name":"country","in":"path","required":true,"schemaId":"schema_2"},{"name":"number","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/numbers?country={country}&number={number}","href":"search-numbers/searchnumbersbymatchingprefix","openApiOperationId":"searchNumbersByMatchingPrefix","summary":"by Matching prefix"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchElement"}},"schemaId":"components/schemas/SearchElement"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail"}},"schemaId":"components/schemas/ErrorDetail"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&number={number}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&number={number}/get/responses/401/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&number={number}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&number={number}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1numbers?country={country}&number={number}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchElement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchElement"}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&number={number}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&number={number}/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&number={number}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&number={number}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search-numbers/searchnumbersbymatchingprefix"}],"panels":[]}]},"httpPath":"/numbers?country={country}&number={number}"},{"label":"by Number Type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/search-numbers/searchnumbersbynumbertype","routeSlug":"/telco-api/references/search-numbers/searchnumbersbynumbertype","metadata":{"seo":{"title":"by Number Type","description":"Search for available numbers matching provided number as close as possible."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchNumbersByNumberType","name":"by Number Type","isWebhook":false,"pointer":"/paths/~1numbers?country={country}&number_type={number_type}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"by Number Type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search for available numbers matching provided number as close as possible."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"search-numbers/searchnumbersbynumbertype/request/number-types","deepLinkHash":"/search-numbers/searchnumbersbynumbertype#search-numbers/searchnumbersbynumbertype/request/number-types"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number Types"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GEO"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Local Numbers, more efficient search using other options"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOLLFREE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOLLFREE numbers, same rate for the calling party independently from the area."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FREECALL"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the calling party, a call to a toll-free number from a landline is free of charge."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MOBILE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mobile numbers"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"country","in":"path","schemaId":"schema_2","description":"Search country.","required":true},{"name":"number_type","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1numbers?country={country}&number_type={number_type}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/numbers?country={country}&number_type={number_type}","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[{"name":"country","in":"path","required":true,"schemaId":"schema_2"},{"name":"number_type","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/numbers?country={country}&number_type={number_type}","href":"search-numbers/searchnumbersbynumbertype","openApiOperationId":"searchNumbersByNumberType","summary":"by Number Type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchElement"}},"schemaId":"components/schemas/SearchElement"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail"}},"schemaId":"components/schemas/ErrorDetail"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&number_type={number_type}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&number_type={number_type}/get/responses/401/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&number_type={number_type}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&number_type={number_type}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1numbers?country={country}&number_type={number_type}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchElement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchElement"}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&number_type={number_type}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&number_type={number_type}/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&number_type={number_type}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?country={country}&number_type={number_type}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search-numbers/searchnumbersbynumbertype"}],"panels":[]}]},"httpPath":"/numbers?country={country}&number_type={number_type}"},{"label":"by SZU Australia","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/search-numbers/searchnumbersbyszuaustralia","routeSlug":"/telco-api/references/search-numbers/searchnumbersbyszuaustralia","metadata":{"seo":{"title":"by SZU Australia","description":"Search for available numbers matching the numbers by Standard Zone Unit (SZU), this option is available for Australia only."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchNumbersBySzuAustralia","name":"by SZU Australia","isWebhook":false,"pointer":"/paths/~1numbers?szu={szu}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"by SZU Australia","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search for available numbers matching the numbers by Standard Zone Unit (SZU), this option is available for Australia only."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most updated list of available Standard Zone Unit for Australia can be found "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://acma.gov.au/Industry/Telco/Numbering/Managing-numbers/numbering-charging-districts-zones-and-precincts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"szu","in":"path","schemaId":"schema_2","description":"Valid Australian SZU","required":true}],"pointer":"/paths/~1numbers?szu={szu}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/numbers?szu={szu}","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[{"name":"szu","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/numbers?szu={szu}","href":"search-numbers/searchnumbersbyszuaustralia","openApiOperationId":"searchNumbersBySzuAustralia","summary":"by SZU Australia"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchElement"}},"schemaId":"components/schemas/SearchElement"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail"}},"schemaId":"components/schemas/ErrorDetail"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?szu={szu}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?szu={szu}/get/responses/401/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?szu={szu}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?szu={szu}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1numbers?szu={szu}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchElement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchElement"}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?szu={szu}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?szu={szu}/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?szu={szu}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1numbers?szu={szu}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search-numbers/searchnumbersbyszuaustralia"}],"panels":[]}]},"httpPath":"/numbers?szu={szu}"}],"content":{"contentType":"group","meta":{"name":"Search Numbers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Numbers","showPageActions":true},{"nodeType":"markdoc","content":"Search into the AVANSER inventory. Search for AVAILABLE Numbers to be ACTIVATED."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/numbers?country={country}&location={location}","summary":"by Location","prefix":{"name":"get","color":"get"},"badges":[],"link":"/search-numbers/searchnumbersbylocation","deprecated":false},{"title":"/numbers?country={country}&lat={lat}&lng={lng}","summary":"by Coordinates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/search-numbers/searchnumbersbycoordinates","deprecated":false},{"title":"/numbers?country={country}&number={number}","summary":"by Matching prefix","prefix":{"name":"get","color":"get"},"badges":[],"link":"/search-numbers/searchnumbersbymatchingprefix","deprecated":false},{"title":"/numbers?country={country}&number_type={number_type}","summary":"by Number Type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/search-numbers/searchnumbersbynumbertype","deprecated":false},{"title":"/numbers?szu={szu}","summary":"by SZU Australia","prefix":{"name":"get","color":"get"},"badges":[],"link":"/search-numbers/searchnumbersbyszuaustralia","deprecated":false}]}]}]}]}},{"type":"group","label":"Requests","link":"/telco-api/references/requests","routeSlug":"/telco-api/references/requests","items":[{"label":"List Requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/requests/listrequests","routeSlug":"/telco-api/references/requests/listrequests","metadata":{"seo":{"title":"List Requests","description":"Returns all requests, requests are returned in batches of 100."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRequests","name":"List Requests","isWebhook":false,"pointer":"/paths/~1requests/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Requests","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all requests, requests are returned in batches of 100."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/requests","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/requests","href":"requests/listrequests","openApiOperationId":"listRequests","summary":"List Requests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRequests"}},"schemaId":"components/schemas/ListRequests"}],"pointer":"/paths/~1requests/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRequests","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRequests"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/requests/listrequests"}],"panels":[]}]},"httpPath":"/requests"},{"label":"Request new Service","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/requests/requestnewservice","routeSlug":"/telco-api/references/requests/requestnewservice","metadata":{"seo":{"title":"Request new Service","description":"Submit a new service request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"requestNewService","name":"Request new Service","isWebhook":false,"pointer":"/paths/~1requests/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request new Service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit a new service request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the request is accepted a number is reserved for this service."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"requests/requestnewservice/request/automatic-number-allocation","deepLinkHash":"/requests/requestnewservice#requests/requestnewservice/request/automatic-number-allocation"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic number allocation"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Along with the service details each new request requires to specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_number"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object allow our customer to specify the \"search rules\" for the new service number easing the number selection process."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What follow is a series of examples on how tok use the automatic number allocation feature:"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"requests/requestnewservice/request/by-location","deepLinkHash":"/requests/requestnewservice#requests/requestnewservice/request/by-location"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by location"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"service_number\":\n {\n  \"country\": \"AU\",\n  \"search_type\": \"location\",\n  \"location\": \"LEVEL 2 150-152 Elizabeth St, 2000 NSW Australia\",\n  \"radius\": 20\n }\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"service_number\":\n {\n  \"country\": \"AU\",\n  \"search_type\": \"location\",\n  \"location\": \"LEVEL 2 150-152 Elizabeth St, 2000 NSW Australia\",\n  \"radius\": 20\n }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"requests/requestnewservice/request/by-coordinates","deepLinkHash":"/requests/requestnewservice#requests/requestnewservice/request/by-coordinates"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by coordinates"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"service_number\":\n {\n  \"country\": \"AU\",\n  \"search_type\": \"location\",\n  \"lat\": -33.865143,\n  \"lng\": 151.209900,\n  \"radius\": 20\n }\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"service_number\":\n {\n  \"country\": \"AU\",\n  \"search_type\": \"location\",\n  \"lat\": -33.865143,\n  \"lng\": 151.209900,\n  \"radius\": 20\n }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"requests/requestnewservice/request/by-\"matching-prefix\"-or-\"service-number\"","deepLinkHash":"/requests/requestnewservice#requests/requestnewservice/request/by-\"matching-prefix\"-or-\"service-number\""},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by \"matching prefix\" or \"service number\""},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"service_number\":\n {\n  \"country\": \"AU\",\n  \"search_type\": \"number\",\n  \"number\": \"61290081596\"\n }\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"service_number\":\n {\n  \"country\": \"AU\",\n  \"search_type\": \"number\",\n  \"number\": \"61290081596\"\n }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be either the number to match as close as possible or one of AVANSER's available service number chosen through Search Numbers service available for this API."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"requests/requestnewservice/request/by-number-type","deepLinkHash":"/requests/requestnewservice#requests/requestnewservice/request/by-number-type"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by number type"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"service_number\":\n {\n  \"country\": \"AU\",\n  \"search_type\": \"number_type\",\n  \"number_type\": \"MOBILE\"\n }\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"service_number\":\n {\n  \"country\": \"AU\",\n  \"search_type\": \"number_type\",\n  \"number_type\": \"MOBILE\"\n }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"requests/requestnewservice/request/by-szu","deepLinkHash":"/requests/requestnewservice#requests/requestnewservice/request/by-szu"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by szu"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"service_number\":\n {\n  \"country\": \"AU\",\n  \"search_type\": \"szu\",\n  \"szu\": \"sydney\"\n }\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"service_number\":\n {\n  \"country\": \"AU\",\n  \"search_type\": \"szu\",\n  \"szu\": \"sydney\"\n }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"requests/requestnewservice/request/example:-new-transfer-service","deepLinkHash":"/requests/requestnewservice#requests/requestnewservice/request/example:-new-transfer-service"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: new transfer service"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer service allows our customer to transfer the Caller Party to the desired Answer Point"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"requests/requestnewservice/request/example:-new-voicemail-service","deepLinkHash":"/requests/requestnewservice#requests/requestnewservice/request/example:-new-voicemail-service"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: new voicemail service"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Voicemail service allows our customers to play a message to the Caller Party and record a message."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message is stored along with the CDR data and is always available either in the Portal or using our WebAPI service."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"requests/requestnewservice/request/example:-new-prompt-service","deepLinkHash":"/requests/requestnewservice#requests/requestnewservice/request/example:-new-prompt-service"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: new prompt service"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prompt service allows our customers to play a message to the Caller Party."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InboundRequest","exampleIds":["paths/~1requests/post/requestBody/content/application~1json/examples/transfer","paths/~1requests/post/requestBody/content/application~1json/examples/transferToAiAgent","paths/~1requests/post/requestBody/content/application~1json/examples/voicemail","paths/~1requests/post/requestBody/content/application~1json/examples/prompt"]}},"schemaId":"components/schemas/InboundRequest","exampleIds":["paths/~1requests/post/requestBody/content/application~1json/examples/transfer","paths/~1requests/post/requestBody/content/application~1json/examples/transferToAiAgent","paths/~1requests/post/requestBody/content/application~1json/examples/voicemail","paths/~1requests/post/requestBody/content/application~1json/examples/prompt"],"pointer":"/paths/~1requests/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/requests","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InboundRequest","exampleIds":["paths/~1requests/post/requestBody/content/application~1json/examples/transfer","paths/~1requests/post/requestBody/content/application~1json/examples/transferToAiAgent","paths/~1requests/post/requestBody/content/application~1json/examples/voicemail","paths/~1requests/post/requestBody/content/application~1json/examples/prompt"]}},"responseCodes":["200","400","401","500"],"pointer":"/requests","href":"requests/requestnewservice","openApiOperationId":"requestNewService","summary":"Request new Service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"schemaId":"components/schemas/InboundRequest","exampleIds":["paths/~1requests/post/requestBody/content/application~1json/examples/transfer","paths/~1requests/post/requestBody/content/application~1json/examples/transferToAiAgent","paths/~1requests/post/requestBody/content/application~1json/examples/voicemail","paths/~1requests/post/requestBody/content/application~1json/examples/prompt"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InboundRequest","exampleIds":["paths/~1requests/post/requestBody/content/application~1json/examples/transfer","paths/~1requests/post/requestBody/content/application~1json/examples/transferToAiAgent","paths/~1requests/post/requestBody/content/application~1json/examples/voicemail","paths/~1requests/post/requestBody/content/application~1json/examples/prompt"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AcknowledgmentReplyWithServiceNumber"}},"schemaId":"components/schemas/AcknowledgmentReplyWithServiceNumber"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail"}},"schemaId":"components/schemas/ErrorDetail"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1requests/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1requests/post/responses/401/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1requests/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1requests/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1requests/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AcknowledgmentReplyWithServiceNumber","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AcknowledgmentReplyWithServiceNumber"}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1requests/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1requests/post/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1requests/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1requests/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/requests/requestnewservice"}],"panels":[]}]},"httpPath":"/requests"}],"content":{"contentType":"group","meta":{"name":"Requests"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Requests","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/requests","summary":"List Requests","prefix":{"name":"get","color":"get"},"badges":[],"link":"/requests/listrequests","deprecated":false},{"title":"/requests","summary":"Request new Service","prefix":{"name":"post","color":"post"},"badges":[],"link":"/requests/requestnewservice","deprecated":false}]}]}]}]}},{"type":"group","label":"Request Details","link":"/telco-api/references/request-details","routeSlug":"/telco-api/references/request-details","items":[{"label":"Request Body","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/request-details/getrequestbody","routeSlug":"/telco-api/references/request-details/getrequestbody","metadata":{"seo":{"title":"Request Body","description":"Returns the submitted user body, this is the request as received"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRequestBody","name":"Request Body","isWebhook":false,"pointer":"/paths/~1requests~1{request_id}~1request_body/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request Body","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the submitted user body, this is the request as received"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"request_id","in":"path","schemaId":"schema_2","description":"Valid request id","required":true,"example":"c9220015e2f48bc7cf4b38186a7b2025"}],"pointer":"/paths/~1requests~1{request_id}~1request_body/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/requests/{request_id}/request_body","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[{"name":"request_id","in":"path","required":true,"example":"c9220015e2f48bc7cf4b38186a7b2025","schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/requests/{request_id}/request_body","href":"request-details/getrequestbody","openApiOperationId":"getRequestBody","summary":"Request Body"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceDetail"}},"schemaId":"components/schemas/ServiceDetail"}],"pointer":"/paths/~1requests~1{request_id}~1request_body/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ServiceDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceDetail"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-details/getrequestbody"}],"panels":[]}]},"httpPath":"/requests/{request_id}/request_body"},{"label":"Acknowledgment Body","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/request-details/getacknowledgmentbody","routeSlug":"/telco-api/references/request-details/getacknowledgmentbody","metadata":{"seo":{"title":"Acknowledgment Body","description":"Returns the acknowledgment request response"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAcknowledgmentBody","name":"Acknowledgment Body","isWebhook":false,"pointer":"/paths/~1requests~1{request_id}~1acknowledgment_body/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Acknowledgment Body","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the acknowledgment request response"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"request_id","in":"path","schemaId":"schema_2","description":"Valid request id","required":true,"example":"c9220015e2f48bc7cf4b38186a7b2025"}],"pointer":"/paths/~1requests~1{request_id}~1acknowledgment_body/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/requests/{request_id}/acknowledgment_body","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[{"name":"request_id","in":"path","required":true,"example":"c9220015e2f48bc7cf4b38186a7b2025","schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/requests/{request_id}/acknowledgment_body","href":"request-details/getacknowledgmentbody","openApiOperationId":"getAcknowledgmentBody","summary":"Acknowledgment Body"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AcknowledgmentReply"}},"schemaId":"components/schemas/AcknowledgmentReply"}],"pointer":"/paths/~1requests~1{request_id}~1acknowledgment_body/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AcknowledgmentReply","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AcknowledgmentReply"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-details/getacknowledgmentbody"}],"panels":[]}]},"httpPath":"/requests/{request_id}/acknowledgment_body"},{"label":"Callback Body","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/request-details/getcallbackbody","routeSlug":"/telco-api/references/request-details/getcallbackbody","metadata":{"seo":{"title":"Callback Body","description":"Returns the callback body set to client's Callback URL"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCallbackBody","name":"Callback Body","isWebhook":false,"pointer":"/paths/~1requests~1{request_id}~1callback_body/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Callback Body","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the callback body set to client's Callback URL"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"request_id","in":"path","schemaId":"schema_2","description":"Valid request id","required":true,"example":"c9220015e2f48bc7cf4b38186a7b2025"}],"pointer":"/paths/~1requests~1{request_id}~1callback_body/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/requests/{request_id}/callback_body","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[{"name":"request_id","in":"path","required":true,"example":"c9220015e2f48bc7cf4b38186a7b2025","schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/requests/{request_id}/callback_body","href":"request-details/getcallbackbody","openApiOperationId":"getCallbackBody","summary":"Callback Body"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CallbackBody"}},"schemaId":"components/schemas/CallbackBody"}],"pointer":"/paths/~1requests~1{request_id}~1callback_body/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CallbackBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CallbackBody"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-details/getcallbackbody"}],"panels":[]}]},"httpPath":"/requests/{request_id}/callback_body"}],"content":{"contentType":"group","meta":{"name":"Request Details"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request Details","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/requests/{request_id}/request_body","summary":"Request Body","prefix":{"name":"get","color":"get"},"badges":[],"link":"/request-details/getrequestbody","deprecated":false},{"title":"/requests/{request_id}/acknowledgment_body","summary":"Acknowledgment Body","prefix":{"name":"get","color":"get"},"badges":[],"link":"/request-details/getacknowledgmentbody","deprecated":false},{"title":"/requests/{request_id}/callback_body","summary":"Callback Body","prefix":{"name":"get","color":"get"},"badges":[],"link":"/request-details/getcallbackbody","deprecated":false}]}]}]}]}},{"type":"group","label":"Manage Services","link":"/telco-api/references/manage-services","routeSlug":"/telco-api/references/manage-services","items":[{"label":"List Services","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/manage-services/listservices","routeSlug":"/telco-api/references/manage-services/listservices","metadata":{"seo":{"title":"List Services","description":"List all active services, services are returned in batches of 100, sorted by name"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listServices","name":"List Services","isWebhook":false,"pointer":"/paths/~1services/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Services","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all active services, services are returned in batches of 100, sorted by name"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/services","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/services","href":"manage-services/listservices","openApiOperationId":"listServices","summary":"List Services"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceList"}},"schemaId":"components/schemas/ServiceList"}],"pointer":"/paths/~1services/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ServiceList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manage-services/listservices"}],"panels":[]}]},"httpPath":"/services"},{"label":"Request service update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/manage-services/updateservice","routeSlug":"/telco-api/references/manage-services/updateservice","metadata":{"seo":{"title":"Request service update","description":"Update the selected service. When updating a service, only the required changes can be submitted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateService","name":"Request service update","isWebhook":false,"pointer":"/paths/~1services~1{service_number}~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request service update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the selected service. When updating a service, only the required changes can be submitted."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"service_number","in":"path","schemaId":"schema_2","description":"valid service number (E164 format)","required":true}],"pointer":"/paths/~1services~1{service_number}~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServiceDetail","exampleIds":["paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/disableCallReporting","paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/updateAnswerPointName","paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/configureTranscription","paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/assignToAiAgent"]}},"schemaId":"components/schemas/ServiceDetail","exampleIds":["paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/disableCallReporting","paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/updateAnswerPointName","paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/configureTranscription","paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/assignToAiAgent"],"pointer":"/paths/~1services~1{service_number}~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/services/{service_number}/","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[{"name":"service_number","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ServiceDetail","exampleIds":["paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/disableCallReporting","paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/updateAnswerPointName","paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/configureTranscription","paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/assignToAiAgent"]}},"responseCodes":["200","400","401","500"],"pointer":"/services/{service_number}/","href":"manage-services/updateservice","openApiOperationId":"updateService","summary":"Request service update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"schemaId":"components/schemas/ServiceDetail","exampleIds":["paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/disableCallReporting","paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/updateAnswerPointName","paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/configureTranscription","paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/assignToAiAgent"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServiceDetail","exampleIds":["paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/disableCallReporting","paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/updateAnswerPointName","paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/configureTranscription","paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/assignToAiAgent"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AcknowledgmentReply"}},"schemaId":"components/schemas/AcknowledgmentReply"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail"}},"schemaId":"components/schemas/ErrorDetail"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1services~1{service_number}~1/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1services~1{service_number}~1/post/responses/401/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1services~1{service_number}~1/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1services~1{service_number}~1/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1services~1{service_number}~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AcknowledgmentReply","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AcknowledgmentReply"}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1services~1{service_number}~1/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1services~1{service_number}~1/post/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1services~1{service_number}~1/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1services~1{service_number}~1/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manage-services/updateservice"}],"panels":[]}]},"httpPath":"/services/{service_number}/"},{"label":"Request service decommission","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/manage-services/decommissionservice","routeSlug":"/telco-api/references/manage-services/decommissionservice","metadata":{"seo":{"title":"Request service decommission","description":"Decommission (cease) the selected service."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"decommissionService","name":"Request service decommission","isWebhook":false,"pointer":"/paths/~1services~1{service_number}~1/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request service decommission","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Decommission (cease) the selected service."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"service_number","in":"path","schemaId":"schema_2","description":"valid service number (E164 format)","required":true}],"pointer":"/paths/~1services~1{service_number}~1/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","pointer":"/paths/~1services~1{service_number}~1/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/services/{service_number}/","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[{"name":"service_number","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5"}},"responseCodes":["200","400","401","500"],"pointer":"/services/{service_number}/","href":"manage-services/decommissionservice","openApiOperationId":"decommissionService","summary":"Request service decommission"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AcknowledgmentReply"}},"schemaId":"components/schemas/AcknowledgmentReply"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail"}},"schemaId":"components/schemas/ErrorDetail"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1services~1{service_number}~1/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1services~1{service_number}~1/delete/responses/401/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1services~1{service_number}~1/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1services~1{service_number}~1/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1services~1{service_number}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AcknowledgmentReply","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AcknowledgmentReply"}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1services~1{service_number}~1/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1services~1{service_number}~1/delete/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1services~1{service_number}~1/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1services~1{service_number}~1/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manage-services/decommissionservice"}],"panels":[]}]},"httpPath":"/services/{service_number}/"}],"content":{"contentType":"group","meta":{"name":"Manage Services"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manage Services","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/services","summary":"List Services","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manage-services/listservices","deprecated":false},{"title":"/services/{service_number}/","summary":"Request service update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manage-services/updateservice","deprecated":false},{"title":"/services/{service_number}/","summary":"Request service decommission","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/manage-services/decommissionservice","deprecated":false}]}]}]}]}},{"type":"group","label":"Manage Templates","link":"/telco-api/references/manage-templates","routeSlug":"/telco-api/references/manage-templates","items":[{"label":"List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/manage-templates/listtemplates","routeSlug":"/telco-api/references/manage-templates/listtemplates","metadata":{"seo":{"title":"List","description":"List all available Templates"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTemplates","name":"List","isWebhook":false,"pointer":"/paths/~1templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all available Templates"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/templates","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/templates","href":"manage-templates/listtemplates","openApiOperationId":"listTemplates","summary":"List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateList"}},"schemaId":"components/schemas/TemplateList"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1templates/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1templates/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/get/responses/401/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplateList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateList"}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1templates/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1templates/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manage-templates/listtemplates"}],"panels":[]}]},"httpPath":"/templates"},{"label":"Create or Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/manage-templates/createorupdatetemplate","routeSlug":"/telco-api/references/manage-templates/createorupdatetemplate","metadata":{"seo":{"title":"Create or Update","description":"Templates support Call Tags"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrUpdateTemplate","name":"Create or Update","isWebhook":false,"pointer":"/paths/~1templates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or Update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Templates support Call Tags"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_2","description":"desired template name","required":true},{"name":"country","in":"query","schemaId":"schema_2","description":"country this template is for","required":true},{"name":"type","in":"query","schemaId":"schema_6","description":"Type of template","example":"email"}],"pointer":"/paths/~1templates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["text/html"],"mediaTypeSchemas":{"text/html":{"schemaId":"schema_2","exampleIds":["paths/~1templates/post/requestBody/content/text~1html/example"]}},"schemaId":"schema_2","exampleIds":["paths/~1templates/post/requestBody/content/text~1html/example"],"pointer":"/paths/~1templates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/templates","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"name","in":"query","required":true,"schemaId":"schema_2"},{"name":"country","in":"query","required":true,"schemaId":"schema_2"},{"name":"type","in":"query","required":false,"example":"email","schemaId":"schema_6"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"text/html":{"schemaId":"schema_2","exampleIds":["paths/~1templates/post/requestBody/content/text~1html/example"]}},"responseCodes":["200","400","401","500"],"pointer":"/templates","href":"manage-templates/createorupdatetemplate","openApiOperationId":"createOrUpdateTemplate","summary":"Create or Update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"schemaId":"schema_2","exampleIds":["paths/~1templates/post/requestBody/content/text~1html/example"],"mediaTypes":["text/html"],"mediaTypeSchemas":{"text/html":{"schemaId":"schema_2","exampleIds":["paths/~1templates/post/requestBody/content/text~1html/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericSuccess"}},"schemaId":"components/schemas/GenericSuccess"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1templates/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1templates/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/post/responses/401/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1templates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GenericSuccess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericSuccess"}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1templates/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1templates/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/post/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manage-templates/createorupdatetemplate"}],"panels":[]}]},"httpPath":"/templates"},{"label":"Delete Template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/manage-templates/deletetemplate","routeSlug":"/telco-api/references/manage-templates/deletetemplate","metadata":{"seo":{"title":"Delete Template","description":"Delete the selected template"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTemplate","name":"Delete Template","isWebhook":false,"pointer":"/paths/~1templates/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete the selected template"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_2","description":"desired template to preview","required":true},{"name":"country","in":"query","schemaId":"schema_2","description":"country this template is for","required":true},{"name":"type","in":"query","schemaId":"schema_6","description":"Type of template","example":"email"}],"pointer":"/paths/~1templates/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["text/html"],"mediaTypeSchemas":{"text/html":{"schemaId":"schema_2"}},"schemaId":"schema_2","pointer":"/paths/~1templates/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/templates","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"name","in":"query","required":true,"schemaId":"schema_2"},{"name":"country","in":"query","required":true,"schemaId":"schema_2"},{"name":"type","in":"query","required":false,"example":"email","schemaId":"schema_6"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"text/html":{"schemaId":"schema_2"}},"responseCodes":["200","400","401","500"],"pointer":"/templates","href":"manage-templates/deletetemplate","openApiOperationId":"deleteTemplate","summary":"Delete Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"schemaId":"schema_2","mediaTypes":["text/html"],"mediaTypeSchemas":{"text/html":{"schemaId":"schema_2"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericSuccess"}},"schemaId":"components/schemas/GenericSuccess"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1templates/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1templates/delete/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/delete/responses/401/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1templates/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GenericSuccess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericSuccess"}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1templates/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1templates/delete/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/delete/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manage-templates/deletetemplate"}],"panels":[]}]},"httpPath":"/templates"},{"label":"Preview Template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/manage-templates/previewtemplate","routeSlug":"/telco-api/references/manage-templates/previewtemplate","metadata":{"seo":{"title":"Preview Template","description":"Preview the selected template"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewTemplate","name":"Preview Template","isWebhook":false,"pointer":"/paths/~1templates?name={name}&country={country}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Preview the selected template"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"schema_2","description":"desired template name","required":true},{"name":"country","in":"path","schemaId":"schema_2","description":"country this template is for","required":true}],"pointer":"/paths/~1templates?name={name}&country={country}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/templates?name={name}&country={country}","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"schema_2"},{"name":"country","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/templates?name={name}&country={country}","href":"manage-templates/previewtemplate","openApiOperationId":"previewTemplate","summary":"Preview Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericSuccess"}},"schemaId":"components/schemas/GenericSuccess"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1templates?name={name}&country={country}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1templates?name={name}&country={country}/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates?name={name}&country={country}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates?name={name}&country={country}/get/responses/401/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates?name={name}&country={country}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates?name={name}&country={country}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1templates?name={name}&country={country}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GenericSuccess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericSuccess"}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1templates?name={name}&country={country}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1templates?name={name}&country={country}/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates?name={name}&country={country}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates?name={name}&country={country}/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates?name={name}&country={country}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1templates?name={name}&country={country}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manage-templates/previewtemplate"}],"panels":[]}]},"httpPath":"/templates?name={name}&country={country}"}],"content":{"contentType":"group","meta":{"name":"Manage Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manage Templates","showPageActions":true},{"nodeType":"markdoc","content":"Allows the customer to configure a template for Email and SMS Call Reporting"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/templates","summary":"List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manage-templates/listtemplates","deprecated":false},{"title":"/templates","summary":"Create or Update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manage-templates/createorupdatetemplate","deprecated":false},{"title":"/templates","summary":"Delete Template","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/manage-templates/deletetemplate","deprecated":false},{"title":"/templates?name={name}&country={country}","summary":"Preview Template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manage-templates/previewtemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"AI Agents","link":"/telco-api/references/ai-agents","routeSlug":"/telco-api/references/ai-agents","items":[{"label":"List AI Agents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/ai-agents/listaiagents","routeSlug":"/telco-api/references/ai-agents/listaiagents","metadata":{"seo":{"title":"List AI Agents","description":"List AI Agents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAiAgents","name":"List AI Agents","isWebhook":false,"pointer":"/paths/~1aiagents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List AI Agents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/aiagents","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","500","502","503"],"pointer":"/aiagents","href":"ai-agents/listaiagents","openApiOperationId":"listAiAgents","summary":"List AI Agents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentList","exampleIds":["paths/~1aiagents/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AIAgentList","exampleIds":["paths/~1aiagents/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/get/responses/401/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/get/responses/500/content/application~1json/example"]},{"code":"502","description":"AI Agent service error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/get/responses/502/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/get/responses/502/content/application~1json/example"]},{"code":"503","description":"AI Agent service is not configured","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/get/responses/503/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/get/responses/503/content/application~1json/example"]}],"pointer":"/paths/~1aiagents/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AIAgentList","exampleIds":["paths/~1aiagents/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentList","exampleIds":["paths/~1aiagents/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/get/responses/500/content/application~1json/example"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/get/responses/502/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/get/responses/502/content/application~1json/example"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/get/responses/503/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/get/responses/503/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-agents/listaiagents"}],"panels":[]}]},"httpPath":"/aiagents"},{"label":"Create AI Agent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/ai-agents/createaiagent","routeSlug":"/telco-api/references/ai-agents/createaiagent","metadata":{"seo":{"title":"Create AI Agent","description":"agent_name, voice, and business_description are required. When instructions are omitted or empty, they are generated from the submitted details; agent_role, business_type, and business_name are then required, with the matching custom field when a role or business type is other."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAiAgent","name":"Create AI Agent","isWebhook":false,"pointer":"/paths/~1aiagents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create AI Agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are required. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instructions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are omitted or empty, they are generated from the submitted details; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent_role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are then required, with the matching custom field when a role or business type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"greeting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional. When omitted, AVANSER stores "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"friendly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which is returned in the created agent."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AIAgentCreateForm","exampleIds":["paths/~1aiagents/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/AIAgentCreateForm","exampleIds":["paths/~1aiagents/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1aiagents/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/aiagents","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AIAgentCreateForm","exampleIds":["paths/~1aiagents/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","500","502","503"],"pointer":"/aiagents","href":"ai-agents/createaiagent","openApiOperationId":"createAiAgent","summary":"Create AI Agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"schemaId":"components/schemas/AIAgentCreateForm","exampleIds":["paths/~1aiagents/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AIAgentCreateForm","exampleIds":["paths/~1aiagents/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentReply","exampleIds":["paths/~1aiagents/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AIAgentReply","exampleIds":["paths/~1aiagents/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/post/responses/401/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/post/responses/500/content/application~1json/example"]},{"code":"502","description":"AI Agent service error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/post/responses/502/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/post/responses/502/content/application~1json/example"]},{"code":"503","description":"AI Agent service is not configured","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/post/responses/503/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/post/responses/503/content/application~1json/example"]}],"pointer":"/paths/~1aiagents/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AIAgentReply","exampleIds":["paths/~1aiagents/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentReply","exampleIds":["paths/~1aiagents/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/post/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/post/responses/500/content/application~1json/example"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/post/responses/502/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/post/responses/502/content/application~1json/example"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/post/responses/503/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents/post/responses/503/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-agents/createaiagent"}],"panels":[]}]},"httpPath":"/aiagents"},{"label":"List Agent Options","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/ai-agents/listaiagentoptions","routeSlug":"/telco-api/references/ai-agents/listaiagentoptions","metadata":{"seo":{"title":"List Agent Options","description":"List Agent Options"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAiAgentOptions","name":"List Agent Options","isWebhook":false,"pointer":"/paths/~1aiagents~1options/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Agent Options","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/aiagents/options","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","500","502","503"],"pointer":"/aiagents/options","href":"ai-agents/listaiagentoptions","openApiOperationId":"listAiAgentOptions","summary":"List Agent Options"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentOptionsReply","exampleIds":["paths/~1aiagents~1options/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AIAgentOptionsReply","exampleIds":["paths/~1aiagents~1options/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1options/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1options/get/responses/401/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1options/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1options/get/responses/500/content/application~1json/example"]},{"code":"502","description":"AI Agent service error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1options/get/responses/502/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1options/get/responses/502/content/application~1json/example"]},{"code":"503","description":"AI Agent service is not configured","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1options/get/responses/503/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1options/get/responses/503/content/application~1json/example"]}],"pointer":"/paths/~1aiagents~1options/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AIAgentOptionsReply","exampleIds":["paths/~1aiagents~1options/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentOptionsReply","exampleIds":["paths/~1aiagents~1options/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1options/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1options/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1options/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1options/get/responses/500/content/application~1json/example"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1options/get/responses/502/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1options/get/responses/502/content/application~1json/example"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1options/get/responses/503/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1options/get/responses/503/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-agents/listaiagentoptions"}],"panels":[]}]},"httpPath":"/aiagents/options"},{"label":"Preview AI Agent Instructions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/ai-agents/previewaiagentinstructions","routeSlug":"/telco-api/references/ai-agents/previewaiagentinstructions","metadata":{"seo":{"title":"Preview AI Agent Instructions","description":"Generate instructions without creating an agent. agent_name, agent_role, business_type, business_name, and business_description are required, with the matching custom field when a role or business type is other. greeting is optional; voice and instructions are ignored."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewAiAgentInstructions","name":"Preview AI Agent Instructions","isWebhook":false,"pointer":"/paths/~1aiagents~1preview-instruction/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview AI Agent Instructions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate instructions without creating an agent. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent_role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are required, with the matching custom field when a role or business type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"greeting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instructions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are ignored."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AIAgentInstructionsForm","exampleIds":["paths/~1aiagents~1preview-instruction/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/AIAgentInstructionsForm","exampleIds":["paths/~1aiagents~1preview-instruction/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1aiagents~1preview-instruction/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/aiagents/preview-instruction","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AIAgentInstructionsForm","exampleIds":["paths/~1aiagents~1preview-instruction/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","500","502","503"],"pointer":"/aiagents/preview-instruction","href":"ai-agents/previewaiagentinstructions","openApiOperationId":"previewAiAgentInstructions","summary":"Preview AI Agent Instructions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"schemaId":"components/schemas/AIAgentInstructionsForm","exampleIds":["paths/~1aiagents~1preview-instruction/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AIAgentInstructionsForm","exampleIds":["paths/~1aiagents~1preview-instruction/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentInstructionsReply","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AIAgentInstructionsReply","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/401/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/500/content/application~1json/example"]},{"code":"502","description":"AI Agent service error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/502/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/502/content/application~1json/example"]},{"code":"503","description":"AI Agent service is not configured","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/503/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/503/content/application~1json/example"]}],"pointer":"/paths/~1aiagents~1preview-instruction/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AIAgentInstructionsReply","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentInstructionsReply","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/500/content/application~1json/example"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/502/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/502/content/application~1json/example"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/503/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1preview-instruction/post/responses/503/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-agents/previewaiagentinstructions"}],"panels":[]}]},"httpPath":"/aiagents/preview-instruction"},{"label":"Get AI Agent Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/ai-agents/getaiagent","routeSlug":"/telco-api/references/ai-agents/getaiagent","metadata":{"seo":{"title":"Get AI Agent Details","description":"Get AI Agent Details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAiAgent","name":"Get AI Agent Details","isWebhook":false,"pointer":"/paths/~1aiagents~1{agent_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get AI Agent Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agent_id","in":"path","schemaId":"schema_7","description":"Agent ID containing letters, digits, hyphens, or underscores only.","required":true,"example":"155"}],"pointer":"/paths/~1aiagents~1{agent_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/aiagents/{agent_id}","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[{"name":"agent_id","in":"path","required":true,"example":"155","schemaId":"schema_7"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","404","500","502","503"],"pointer":"/aiagents/{agent_id}","href":"ai-agents/getaiagent","openApiOperationId":"getAiAgent","summary":"Get AI Agent Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentDetailReply","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AIAgentDetailReply","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/401/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/500/content/application~1json/example"]},{"code":"502","description":"AI Agent service error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/502/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/502/content/application~1json/example"]},{"code":"503","description":"AI Agent service is not configured","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/503/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/503/content/application~1json/example"]}],"pointer":"/paths/~1aiagents~1{agent_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AIAgentDetailReply","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentDetailReply","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/500/content/application~1json/example"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/502/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/502/content/application~1json/example"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/503/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/get/responses/503/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-agents/getaiagent"}],"panels":[]}]},"httpPath":"/aiagents/{agent_id}"},{"label":"Update AI Agent","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/ai-agents/updateaiagent","routeSlug":"/telco-api/references/ai-agents/updateaiagent","metadata":{"seo":{"title":"Update AI Agent","description":"Only submitted fields are changed. The resulting agent_name, voice, business_description, and instructions must remain populated, including when a field is omitted from the request. A resulting agent_role or business_type of other requires its matching custom field to remain populated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAiAgent","name":"Update AI Agent","isWebhook":false,"pointer":"/paths/~1aiagents~1{agent_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update AI Agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only submitted fields are changed. The resulting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instructions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must remain populated, including when a field is omitted from the request. A resulting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent_role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requires its matching custom field to remain populated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submitted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent_role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"greeting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values are checked against List Agent Options. The resulting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is checked even when it was retained from the existing agent. Instructions are never regenerated on update."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agent_id","in":"path","schemaId":"schema_7","description":"Agent ID containing letters, digits, hyphens, or underscores only.","required":true,"example":"155"}],"pointer":"/paths/~1aiagents~1{agent_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AIAgentUpdateForm","exampleIds":["paths/~1aiagents~1{agent_id}/put/requestBody/content/application~1json/examples/greeting","paths/~1aiagents~1{agent_id}/put/requestBody/content/application~1json/examples/instructions"]}},"schemaId":"components/schemas/AIAgentUpdateForm","exampleIds":["paths/~1aiagents~1{agent_id}/put/requestBody/content/application~1json/examples/greeting","paths/~1aiagents~1{agent_id}/put/requestBody/content/application~1json/examples/instructions"],"pointer":"/paths/~1aiagents~1{agent_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/aiagents/{agent_id}","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[{"name":"agent_id","in":"path","required":true,"example":"155","schemaId":"schema_7"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AIAgentUpdateForm","exampleIds":["paths/~1aiagents~1{agent_id}/put/requestBody/content/application~1json/examples/greeting","paths/~1aiagents~1{agent_id}/put/requestBody/content/application~1json/examples/instructions"]}},"responseCodes":["200","400","401","404","500","502","503"],"pointer":"/aiagents/{agent_id}","href":"ai-agents/updateaiagent","openApiOperationId":"updateAiAgent","summary":"Update AI Agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"schemaId":"components/schemas/AIAgentUpdateForm","exampleIds":["paths/~1aiagents~1{agent_id}/put/requestBody/content/application~1json/examples/greeting","paths/~1aiagents~1{agent_id}/put/requestBody/content/application~1json/examples/instructions"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AIAgentUpdateForm","exampleIds":["paths/~1aiagents~1{agent_id}/put/requestBody/content/application~1json/examples/greeting","paths/~1aiagents~1{agent_id}/put/requestBody/content/application~1json/examples/instructions"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentReply","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AIAgentReply","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/401/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/404/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/500/content/application~1json/example"]},{"code":"502","description":"AI Agent service error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/502/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/502/content/application~1json/example"]},{"code":"503","description":"AI Agent service is not configured","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/503/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/503/content/application~1json/example"]}],"pointer":"/paths/~1aiagents~1{agent_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AIAgentReply","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentReply","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/500/content/application~1json/example"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/502/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/502/content/application~1json/example"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/503/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/put/responses/503/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-agents/updateaiagent"}],"panels":[]}]},"httpPath":"/aiagents/{agent_id}"},{"label":"Delete AI Agent","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/ai-agents/deleteaiagent","routeSlug":"/telco-api/references/ai-agents/deleteaiagent","metadata":{"seo":{"title":"Delete AI Agent","description":"Delete AI Agent"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAiAgent","name":"Delete AI Agent","isWebhook":false,"pointer":"/paths/~1aiagents~1{agent_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete AI Agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agent_id","in":"path","schemaId":"schema_7","description":"Agent ID containing letters, digits, hyphens, or underscores only.","required":true,"example":"155"}],"pointer":"/paths/~1aiagents~1{agent_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/aiagents/{agent_id}","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[{"name":"agent_id","in":"path","required":true,"example":"155","schemaId":"schema_7"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","404","500","502","503"],"pointer":"/aiagents/{agent_id}","href":"ai-agents/deleteaiagent","openApiOperationId":"deleteAiAgent","summary":"Delete AI Agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentDeleteReply"}},"schemaId":"components/schemas/AIAgentDeleteReply"},{"code":"400","description":"Bad Request. The agent still has assigned tracking numbers or is targeted by a menu route.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/401/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/404/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/500/content/application~1json/example"]},{"code":"502","description":"AI Agent service error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/502/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/502/content/application~1json/example"]},{"code":"503","description":"AI Agent service is not configured","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/503/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/503/content/application~1json/example"]}],"pointer":"/paths/~1aiagents~1{agent_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AIAgentDeleteReply","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentDeleteReply"}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/500/content/application~1json/example"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/502/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/502/content/application~1json/example"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/503/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}/delete/responses/503/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-agents/deleteaiagent"}],"panels":[]}]},"httpPath":"/aiagents/{agent_id}"},{"label":"Get AI Agent Advanced Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/ai-agents/getaiagentadvancedsettings","routeSlug":"/telco-api/references/ai-agents/getaiagentadvancedsettings","metadata":{"seo":{"title":"Get AI Agent Advanced Settings","description":"Get AI Agent Advanced Settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAiAgentAdvancedSettings","name":"Get AI Agent Advanced Settings","isWebhook":false,"pointer":"/paths/~1aiagents~1{agent_id}~1advanced-settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get AI Agent Advanced Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agent_id","in":"path","schemaId":"schema_7","description":"Agent ID containing letters, digits, hyphens, or underscores only.","required":true,"example":"155"}],"pointer":"/paths/~1aiagents~1{agent_id}~1advanced-settings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/aiagents/{agent_id}/advanced-settings","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[{"name":"agent_id","in":"path","required":true,"example":"155","schemaId":"schema_7"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","404","500","502","503"],"pointer":"/aiagents/{agent_id}/advanced-settings","href":"ai-agents/getaiagentadvancedsettings","openApiOperationId":"getAiAgentAdvancedSettings","summary":"Get AI Agent Advanced Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentAdvancedSettingsGetReply","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AIAgentAdvancedSettingsGetReply","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/401/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/500/content/application~1json/example"]},{"code":"502","description":"AI Agent service error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/502/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/502/content/application~1json/example"]},{"code":"503","description":"AI Agent service is not configured","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/503/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/503/content/application~1json/example"]}],"pointer":"/paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AIAgentAdvancedSettingsGetReply","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentAdvancedSettingsGetReply","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/500/content/application~1json/example"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/502/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/502/content/application~1json/example"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/503/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/503/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-agents/getaiagentadvancedsettings"}],"panels":[]}]},"httpPath":"/aiagents/{agent_id}/advanced-settings"},{"label":"Update AI Agent Advanced Settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/ai-agents/updateaiagentadvancedsettings","routeSlug":"/telco-api/references/ai-agents/updateaiagentadvancedsettings","metadata":{"seo":{"title":"Update AI Agent Advanced Settings","description":"Update AI Agent Advanced Settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAiAgentAdvancedSettings","name":"Update AI Agent Advanced Settings","isWebhook":false,"pointer":"/paths/~1aiagents~1{agent_id}~1advanced-settings/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update AI Agent Advanced Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agent_id","in":"path","schemaId":"schema_7","description":"Agent ID containing letters, digits, hyphens, or underscores only.","required":true,"example":"155"}],"pointer":"/paths/~1aiagents~1{agent_id}~1advanced-settings/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AIAgentAdvancedSettingsForm","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/AIAgentAdvancedSettingsForm","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1aiagents~1{agent_id}~1advanced-settings/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/aiagents/{agent_id}/advanced-settings","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[{"name":"agent_id","in":"path","required":true,"example":"155","schemaId":"schema_7"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AIAgentAdvancedSettingsForm","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","500","502","503"],"pointer":"/aiagents/{agent_id}/advanced-settings","href":"ai-agents/updateaiagentadvancedsettings","openApiOperationId":"updateAiAgentAdvancedSettings","summary":"Update AI Agent Advanced Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"schemaId":"components/schemas/AIAgentAdvancedSettingsForm","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AIAgentAdvancedSettingsForm","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentAdvancedSettingsReply","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AIAgentAdvancedSettingsReply","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. agent_id may be invalid or route_id may be an unsupported route type."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/401/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/500/content/application~1json/example"]},{"code":"502","description":"AI Agent service error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/502/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/502/content/application~1json/example"]},{"code":"503","description":"AI Agent service is not configured","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/503/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/503/content/application~1json/example"]}],"pointer":"/paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AIAgentAdvancedSettingsReply","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentAdvancedSettingsReply","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/500/content/application~1json/example"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/502/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/502/content/application~1json/example"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/503/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/503/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-agents/updateaiagentadvancedsettings"}],"panels":[]}]},"httpPath":"/aiagents/{agent_id}/advanced-settings"},{"label":"List AI Agent Assigned Numbers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/ai-agents/listaiagentassignednumbers","routeSlug":"/telco-api/references/ai-agents/listaiagentassignednumbers","metadata":{"seo":{"title":"List AI Agent Assigned Numbers","description":"List AI Agent Assigned Numbers"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAiAgentAssignedNumbers","name":"List AI Agent Assigned Numbers","isWebhook":false,"pointer":"/paths/~1aiagents~1{agent_id}~1assigned-numbers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List AI Agent Assigned Numbers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agent_id","in":"path","schemaId":"schema_7","description":"Agent ID containing letters, digits, hyphens, or underscores only.","required":true,"example":"155"}],"pointer":"/paths/~1aiagents~1{agent_id}~1assigned-numbers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/aiagents/{agent_id}/assigned-numbers","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[{"name":"agent_id","in":"path","required":true,"example":"155","schemaId":"schema_7"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","404","500","502","503"],"pointer":"/aiagents/{agent_id}/assigned-numbers","href":"ai-agents/listaiagentassignednumbers","openApiOperationId":"listAiAgentAssignedNumbers","summary":"List AI Agent Assigned Numbers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentAssignedNumberList","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AIAgentAssignedNumberList","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/401/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/500/content/application~1json/example"]},{"code":"502","description":"AI Agent service error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/502/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/502/content/application~1json/example"]},{"code":"503","description":"AI Agent service is not configured","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/503/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/503/content/application~1json/example"]}],"pointer":"/paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AIAgentAssignedNumberList","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentAssignedNumberList","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/500/content/application~1json/example"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/502/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/502/content/application~1json/example"]}}},{"code":"503","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/503/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/503/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-agents/listaiagentassignednumbers"}],"panels":[]}]},"httpPath":"/aiagents/{agent_id}/assigned-numbers"},{"label":"List Transfer Routes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/telco-api/references/ai-agents/listtransferroutes","routeSlug":"/telco-api/references/ai-agents/listtransferroutes","metadata":{"seo":{"title":"List Transfer Routes","description":"List Transfer Routes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTransferRoutes","name":"List Transfer Routes","isWebhook":false,"pointer":"/paths/~1transferroutes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Transfer Routes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTP_BASIC","scopes":[],"type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transferroutes","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"HTTP_BASIC","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/transferroutes","href":"ai-agents/listtransferroutes","openApiOperationId":"listTransferRoutes","summary":"List Transfer Routes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","description":"AVANSER Mock Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferRouteList","exampleIds":["paths/~1transferroutes/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/TransferRouteList","exampleIds":["paths/~1transferroutes/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1transferroutes/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1transferroutes/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1transferroutes/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1transferroutes/get/responses/401/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1transferroutes/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1transferroutes/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Unexpected Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1transferroutes/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1transferroutes/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1transferroutes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransferRouteList","exampleIds":["paths/~1transferroutes/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferRouteList","exampleIds":["paths/~1transferroutes/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1transferroutes/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDetail","exampleIds":["paths/~1transferroutes/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1transferroutes/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1transferroutes/get/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1transferroutes/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1transferroutes/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1transferroutes/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1transferroutes/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-agents/listtransferroutes"}],"panels":[]}]},"httpPath":"/transferroutes"}],"content":{"contentType":"group","meta":{"name":"AI Agents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AI Agents","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/aiagents","summary":"List AI Agents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ai-agents/listaiagents","deprecated":false},{"title":"/aiagents","summary":"Create AI Agent","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ai-agents/createaiagent","deprecated":false},{"title":"/aiagents/options","summary":"List Agent Options","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ai-agents/listaiagentoptions","deprecated":false},{"title":"/aiagents/preview-instruction","summary":"Preview AI Agent Instructions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ai-agents/previewaiagentinstructions","deprecated":false},{"title":"/aiagents/{agent_id}","summary":"Get AI Agent Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ai-agents/getaiagent","deprecated":false},{"title":"/aiagents/{agent_id}","summary":"Update AI Agent","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ai-agents/updateaiagent","deprecated":false},{"title":"/aiagents/{agent_id}","summary":"Delete AI Agent","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ai-agents/deleteaiagent","deprecated":false},{"title":"/aiagents/{agent_id}/advanced-settings","summary":"Get AI Agent Advanced Settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ai-agents/getaiagentadvancedsettings","deprecated":false},{"title":"/aiagents/{agent_id}/advanced-settings","summary":"Update AI Agent Advanced Settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ai-agents/updateaiagentadvancedsettings","deprecated":false},{"title":"/aiagents/{agent_id}/assigned-numbers","summary":"List AI Agent Assigned Numbers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ai-agents/listaiagentassignednumbers","deprecated":false},{"title":"/transferroutes","summary":"List Transfer Routes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ai-agents/listtransferroutes","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Transaction":{"id":"components/schemas/Transaction","kind":"json-schema","title":"Transaction","data":{"type":"object","properties":{"@transaction":{"type":"object","properties":{"id":{"type":"string","description":"Unique transaction ID","example":"c9220015e2f48bc7cf4b38186a7b2025"},"account-id":{"type":["string","number"],"description":"Currently selected account. AI Agent responses serialize this as a string.","example":"5995"},"request":{"type":"object","properties":{"api-version":{"type":"string","description":"API Version","example":"v1"},"method":{"type":"string","description":"HTTP Request Method","example":"POST"},"path":{"type":"string","description":"Current resource url","example":"/{resource}/?{parameters}"},"time":{"type":"string","description":"Response date/time","example":"2016-09-06T16:13:38+10:00","format":"date-time"},"ms":{"type":["string","number"],"description":"Request process time in milliseconds. AI Agent responses serialize this as a string.","example":"0.837"}}}}}}}},"components/schemas/items":{"id":"components/schemas/items","kind":"json-schema","title":"items","data":{"type":"object","properties":{"account-id":{"type":"number","description":"Currently selected account"},"account":{"type":"string","description":"Friendly name assigned to the account","example":"Test Account"}}}},"components/schemas/Accounts":{"id":"components/schemas/Accounts","kind":"json-schema","title":"Accounts","data":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"type":"object","properties":{"response":{"type":"array","items":{"$ref":"#/components/schemas/items"}}}}]}},"components/schemas/ErrorDetail":{"id":"components/schemas/ErrorDetail","kind":"json-schema","title":"ErrorDetail","data":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"example":"Bad Request"},"code":{"example":400}}},"errors":{"type":"object","additionalProperties":{"type":"string"},"example":{"answer_point":"invalid number"}}}}]}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"allOf":[{"$ref":"#/components/schemas/ErrorDetail"},{"type":"object","properties":{"errors":{"type":"object","properties":{"description":{"type":"string","description":"Error description","example":"error message"},"code":{"type":"string","description":"Error code","example":"error code"}}}}}]}},"components/schemas/GenericSuccess":{"id":"components/schemas/GenericSuccess","kind":"json-schema","title":"GenericSuccess","data":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"type":"object","properties":{"response":{"type":"object","properties":{"message":{"type":"string","description":"Confirmation message","example":"Success"},"code":{"type":"number","description":"Confirmation code","example":200}}}}}]}},"components/schemas/items-2":{"id":"components/schemas/items-2","kind":"json-schema","title":"items-2","data":{"type":"object","properties":{"client_name":{"type":"string","example":"# AVANSER test EDB"},"client_id":{"type":"string","example":"5995"},"abn":{"type":"string","example":"11 223 491 505"},"primary_contact":{"type":"object","properties":{"name":{"type":"string","example":"AVANSER"},"email":{"type":"string","example":"test@email.com"},"phone":{"type":"string","example":"0412345678"}}},"billing_contact":{"type":"object","properties":{"name":{"type":"string","example":"AVANSER"},"email":{"type":"string","example":"test@email.com"}}},"invoice_address":{"type":"object","properties":{"client_name":{"type":"string","example":"AVANSER test EDB"},"address_line_1":{"type":"string","example":"Level 2, 152 Elizabeth St"},"address_line_2":{"type":"string","example":""},"suburb":{"type":"string","example":"Sydney"},"state":{"type":"string","example":"NSW"},"post_code":{"type":"string","example":"2000"}}}}}},"components/schemas/accountDetails":{"id":"components/schemas/accountDetails","kind":"json-schema","title":"accountDetails","data":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"type":"object","properties":{"response":{"type":"array","items":{"$ref":"#/components/schemas/items-2"}}}}]}},"components/schemas/items-3":{"id":"components/schemas/items-3","kind":"json-schema","title":"items-3","data":{"type":"object","properties":{"package_code":{"type":"string","example":"corporate"},"start_date":{"type":"string","example":"2016-12-07"},"end_date":{"type":"string","example":"2017-01-07"},"setup_charge":{"type":"string","example":"250.00"},"monthly_charge":{"type":"string","example":"1.00"},"email":{"type":"string","example":"test@email.com"},"fixed_call_rate":{"type":"object","properties":{"included":{"type":"string","example":"0"},"perMinute":{"type":"string","example":"1.50"}}},"rates":{"type":"array","items":{"type":"object","properties":{"callType":{"type":"string","example":"default"},"price":{"type":"string","example":"0.25"},"usage":{"type":"string","example":"100"}}}}}}},"components/schemas/accountPackages":{"id":"components/schemas/accountPackages","kind":"json-schema","title":"accountPackages","data":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"type":"object","properties":{"response":{"type":"array","items":{"$ref":"#/components/schemas/items-3"}}}}]}},"components/schemas/items-4":{"id":"components/schemas/items-4","kind":"json-schema","title":"items-4","data":{"type":"object","properties":{"rate_code":{"type":"string","example":"61"},"description":{"type":"string","example":"Test MMT"},"setup_date":{"type":"string","example":"2017-01-07"},"setup_charge":{"type":"string","example":"0.00"},"rental_charge":{"type":"string","example":"0.00"}}}},"components/schemas/accountNumberRates":{"id":"components/schemas/accountNumberRates","kind":"json-schema","title":"accountNumberRates","data":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"type":"object","properties":{"response":{"type":"array","items":{"$ref":"#/components/schemas/items-4"}}}}]}},"components/schemas/items-5":{"id":"components/schemas/items-5","kind":"json-schema","title":"items-5","data":{"type":"object","properties":{"rate_code":{"type":"string","example":"61"},"call_type":{"type":"string","example":"L"},"cost_per_minute":{"type":"string","example":"0.39"},"free_seconds":{"type":"string","example":"0.00"},"minimum_seconds":{"type":"string","example":"0.00"}}}},"components/schemas/accountCallRates":{"id":"components/schemas/accountCallRates","kind":"json-schema","title":"accountCallRates","data":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"type":"object","properties":{"response":{"type":"array","items":{"$ref":"#/components/schemas/items-5"}}}}]}},"components/schemas/items-6":{"id":"components/schemas/items-6","kind":"json-schema","title":"items-6","data":{"type":"object","properties":{"setup_date":{"type":"string","example":"2020-09-08"},"rate":{"type":"string","example":"0.1"}}}},"components/schemas/accountTranscriptionRates":{"id":"components/schemas/accountTranscriptionRates","kind":"json-schema","title":"accountTranscriptionRates","data":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"type":"object","properties":{"response":{"type":"array","items":{"$ref":"#/components/schemas/items-6"}}}}]}},"components/schemas/items-7":{"id":"components/schemas/items-7","kind":"json-schema","title":"items-7","data":{"type":"object","properties":{"feature_code":{"type":"string","example":"TBR"},"description":{"type":"string","example":"Time Based Routing"},"start_date":{"type":"string","example":"2017-08-01"},"end_date":{"type":"string","example":"2017-10-01"},"setup_charge":{"type":"string","example":"350.00"},"monthly_charge":{"type":"string","example":"250.00"},"change_charge":{"type":"string","example":"0.00"},"charging_method":{"type":"string","example":"usage"},"charge_term":{"type":"string","example":"advance"}}}},"components/schemas/accountFeatures":{"id":"components/schemas/accountFeatures","kind":"json-schema","title":"accountFeatures","data":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"type":"object","properties":{"response":{"type":"array","items":{"$ref":"#/components/schemas/items-7"}}}}]}},"components/schemas/SearchElement":{"id":"components/schemas/SearchElement","kind":"json-schema","title":"SearchElement","data":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"type":"object","properties":{"response":{"type":"object","properties":{"E164 Number":{"type":"object","properties":{"country":{"type":"string","description":"Service Country","example":"AU"},"region":{"type":"string","description":"Number Region","example":"NSW: Sydney"},"type":{"type":"string","description":"Number Type","example":"GEO"},"national":{"type":"string","description":"Number in national format","example":"0290081596"},"calling_code":{"type":"string","description":"International calling code","example":"+61"}}}}}}}]}},"components/schemas/MultipleAddresses":{"id":"components/schemas/MultipleAddresses","kind":"json-schema","title":"MultipleAddresses","data":{"allOf":[{"$ref":"#/components/schemas/ErrorResponse"},{"type":"object","properties":{"errors":{"type":"object","properties":{"location":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Location address","example":"Sydney, NSW, AU"},"state":{"type":"string","description":"Location state","example":"NSW"},"country":{"type":"string","description":"Location country","example":"AU"},"lat_lng":{"type":"array","description":"Geo Location","items":{"type":"number"},"example":[-33.8688197,151.2092955]}}}}}}}}]}},"components/schemas/RequestRecord":{"id":"components/schemas/RequestRecord","kind":"json-schema","title":"RequestRecord","data":{"type":"object","properties":{"id":{"type":"string","description":"Request unique id","example":"8bc7cf4015e2f4b38186c9220a7b2025"},"request_type":{"type":"string","description":"Request Type","enum":["create","update","delete"],"example":"create"},"custom_id":{"type":"string","description":"Desired unique id (50 chars max)","example":"desired id"},"custom_group":{"type":"string","description":"Desired unique id (50 chars max)","example":"desired group"},"request_date":{"type":"string","description":"Date and time request was received (ISO 8601 Date format)","example":"2016-09-06T16:13:38+10:00"},"callback_date":{"type":"string","description":"Date and time reply was sent to client's callback url (ISO 8601 Date format)","example":"2016-09-06T16:13:38+10:00"},"request_status":{"type":"string","description":"Request Status","enum":["pending","completed","pending_confirmation","failed","reported"],"example":"completed"},"message":{"type":"string","description":"Request status notes","example":"Request completed successfully"},"service_number":{"type":"string","description":"Provisioned service number","example":"6129008596"},"answer_point":{"type":"string","description":"Answer Point specified at request submission","example":"61401010000"},"callback_url":{"type":"string","description":"Callback-URL specified at request submission","example":"http://preferred/host/"},"@links":{"type":"object","description":"Links to request raw data, returned as plain text","properties":{"request_body":{"type":"string","description":"submitted request body","example":"/requests/{request_id}/request_body"},"acknowledgment_body":{"type":"string","description":"request acknowledgment reply body","example":"/requests/{request_id}/acknowledgment_body"},"callback_body":{"type":"string","description":"request callback body sent to client's endpoint","example":"/requests/{request_id}/callback_body"}}},"@callback":{"type":"object","description":"Callback information","properties":{"last_update":{"type":"string","description":"date of last attempt to contact client's callback-URL","example":"2016-09-06T16:13:38+10:00"},"status":{"description":"callback status","enum":["pending","success","retry","failed"],"example":"pending"},"http_reply":{"type":"number","description":"Received HTTP Status code","example":0}}}}}},"components/schemas/ListRequests":{"id":"components/schemas/ListRequests","kind":"json-schema","title":"ListRequests","data":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"type":"object","properties":{"@next":{"type":"string","description":"link to next 100 requests","example":"/requests/2"},"response":{"type":"array","items":{"$ref":"#/components/schemas/RequestRecord"}}}}]}},"components/schemas/CallReporting":{"id":"components/schemas/CallReporting","kind":"json-schema","title":"CallReporting","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email & SMS Call Reporting configuration"},"children":[]}]}]}],"properties":{"report":{"type":"string","description":"configure Call Reporting","enum":["missed","missed-voicemail","all-calls","none"],"default":"none","example":"missed"},"email":{"type":"object","description":"configure email specific settings, settings are required if this object is defined","required":["subject","email_to","email_cc","email_bcc"],"properties":{"subject":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supports call_tags"},"children":[]}]}]}],"example":"email subject"},"email_to":{"type":"array","description":"email TO recipient list","items":{"type":"string"},"example":["email@email.com","another@email.com"]},"email_cc":{"type":"array","description":"email CC recipient list","items":{"type":"string"},"example":["email@email.com","another@email.com"]},"email_bcc":{"type":"array","description":"email BCC recipient list","items":{"type":"string"},"example":["email@email.com","another@email.com"]},"template":{"type":"string","description":"if defined must be a valid template previously saved, if empty a standard template is used","example":"html_email_template"}}},"sms":{"type":"object","description":"configure sms specific settings, settings are required if this object is defined","required":["mobile"],"properties":{"sms_id":{"type":"string","description":"desired sms id","default":"AVANSER","example":"call report"},"mobile":{"type":"string","description":"sms recipient","example":"614200220001"},"template":{"type":"string","description":"if defined must be a valid template previously saved, if empty a standard AVANSER template is used","example":"text_sms_template"}}}}}},"components/schemas/Transcription":{"id":"components/schemas/Transcription","kind":"json-schema","title":"Transcription","data":{"type":"object","description":"Call transcription and sensitive-data redaction settings","properties":{"transcribe_call":{"type":"boolean","description":"Enable or disable call transcription","example":true},"enable_pci_redaction":{"type":"boolean","description":"Enable or disable Payment Card Industry (PCI) data redaction in call transcriptions","example":true},"enable_pii_redaction":{"type":"boolean","description":"Enable or disable Personally Identifiable Information (PII) redaction in call transcriptions","example":true}}}},"components/schemas/InboundService":{"id":"components/schemas/InboundService","kind":"json-schema","title":"InboundService","data":{"type":"object","description":"Service configuration details","required":["type"],"properties":{"type":{"type":"string","description":"requested service type","enum":["transfer","voicemail","prompt"],"example":"transfer"},"answer_point":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Desired Answer Point: an E164 number or an AI Agent answer point (+AIA-AIAGENTID{id}, +AIM-AIAGENTID{id}, or +AIS-AIAGENTID{id}); required if type = transfer."},"children":[]}]}]}],"example":"61401010023"},"answer_point_name":{"description":"friendly Name for Answer Point","example":"Sydney Office"},"record_call":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enable or disable call recording service, required if type = transfer"},"children":[]}]}]}],"example":true},"transcription":{"$ref":"#/components/schemas/Transcription"},"call_greeting":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this message is played to the calling party, type = transfer only, if empty uses client's default greeting"},"children":[]}]}]}],"example":"http://path/to/greeting.wav"},"call_whisper":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this message is played to the answer point when a call is forwarded, type = transfer only, if empty uses client's default greeting"},"children":[]}]}]}],"example":"http://path/to/greeting.wav"},"voicemail":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this message is played to the calling party if the call is not forwarded before recording a voicemail message, type = transfer only, if empty uses client's default greeting"},"children":[]}]}]}],"example":"http://path/to/voicemail.wav"},"call_reporting":{"$ref":"#/components/schemas/CallReporting"}}}},"components/schemas/InboundRequest":{"id":"components/schemas/InboundRequest","kind":"json-schema","title":"InboundRequest","data":{"type":"object","properties":{"name":{"description":"Friendly name","example":"Tracking Service 1"},"custom_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom_id is returned in the confirmation callback"},"children":[]}]}]}],"example":"{any custom unique id}"},"service_number":{"type":"object","description":"Provide information about the requested service","properties":{"country":{"description":"country (ISO 3166-1 alpha-2 format)","example":"AU"},"search_type":{"type":"string","description":"lookup type, only one search type supported","enum":["coordinates","location","prefix","number_type","number"],"example":"szu"},"szu":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specify the SZU, required if search_type = szu"},"children":[]}]}]}],"example":"sydney"},"radius":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"area search radius, required if search_type = coordinates or search_type = location"},"children":[]}]}]}],"example":20},"lat":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specify latitude, required if search_type = coordinates"},"children":[]}]}]}],"example":55},"long":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specify longitude, required if search_type = coordinates"},"children":[]}]}]}],"example":88.1},"location":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"location address, required if search_type = location"},"children":[]}]}]}],"example":"Sydney, 2000 NSW, Australia"},"number_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"search by number type, required if search_type = number_type"},"children":[]}]}]}],"enum":["tollfree","freecall","mobile"],"example":"tollfree"},"number":{"description":"Number found through the Search functionalities","example":61290081596}}},"service":{"$ref":"#/components/schemas/InboundService"},"call_uri":{"type":"string","description":"if defined sets the url for the Call-URI functionality, each call is reported to this url if configured.","example":"http://path/to/call_reporting_uri"},"sms_forward_uri":{"type":"string","description":"If defined, each inbound SMS is sent to this URL using HTTP POST, with the parameters in the request body.","example":"http://path/to/sms_forward_uri"},"callback_uri":{"type":"string","description":"if defined sets the url for the Callback-URI functionality, if defined callback is sent when request status is updated.","example":"http://path/to/callback_uri"}}}},"components/schemas/AcknowledgmentReply":{"id":"components/schemas/AcknowledgmentReply","kind":"json-schema","title":"AcknowledgmentReply","data":{"allOf":[{"$ref":"#/components/schemas/GenericSuccess"},{"type":"object","properties":{"response":{"type":"object","properties":{"request_id":{"type":"string","description":"Unique Request id","example":"c9220015e2f48bc7cf4b38186a7b2025"},"message":{"type":"string","description":"Confirmation message","example":"Success"},"code":{"type":"number","description":"Confirmation code","example":200}}}}}]}},"components/schemas/AcknowledgmentReplyWithServiceNumber":{"id":"components/schemas/AcknowledgmentReplyWithServiceNumber","kind":"json-schema","title":"AcknowledgmentReplyWithServiceNumber","data":{"allOf":[{"$ref":"#/components/schemas/AcknowledgmentReply"},{"type":"object","properties":{"response":{"type":"object","properties":{"service_number":{"type":"string","description":"reserved number","example":"6129008596"},"request_id":{"type":"string","description":"Unique Request id","example":"c9220015e2f48bc7cf4b38186a7b2025"},"message":{"type":"string","description":"Confirmation message","example":"Success"},"code":{"type":"number","description":"Confirmation code","example":200}}}}}]}},"components/schemas/ServiceDetail":{"id":"components/schemas/ServiceDetail","kind":"json-schema","title":"ServiceDetail","data":{"type":"object","properties":{"name":{"type":"string","description":"desired service friendly name","example":"Tracking Service 1"},"service_number":{"type":"string","description":"configured service number (E164 format)","example":"61290081596"},"service":{"type":"object","description":"Service configuration details","properties":{"type":{"type":"string","description":"requested service type","enum":["transfer","voicemail"],"example":"transfer"},"answer_point":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Desired Answer Point: an E164 number or an AI Agent answer point (+AIA-AIAGENTID{id}, +AIM-AIAGENTID{id}, or +AIS-AIAGENTID{id}); required if type = transfer."},"children":[]}]}]}],"example":"61401010023"},"answer_point_name":{"type":"string","description":"friendly Name for Answer Point","example":"Sydney Office"},"record_call":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enable or disable call recording service, required if type = transfer"},"children":[]}]}]}],"example":true},"transcription":{"$ref":"#/components/schemas/Transcription"},"call_greeting":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this message is played to the calling party, type = transfer only, if empty uses client's default greeting"},"children":[]}]}]}],"example":"http://path/to/greeting.wav"},"call_whisper":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this message is played to the answer point when a call is forwarded, type = transfer only, if empty uses client's default greeting"},"children":[]}]}]}],"example":"http://path/to/greeting.wav"},"voicemail":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this message is played to the calling party if the call is not forwarded before recording a voicemail message, type = transfer only, if empty uses client's default greeting"},"children":[]}]}]}],"example":"http://path/to/voicemail.wav"},"call_reporting":{"$ref":"#/components/schemas/CallReporting"}}},"call_uri":{"type":"string","description":"if defined sets the url for the Call-URI functionality, each call is reported to this url if configured.","example":"http://path/to/call_reporting_uri"},"sms_forward_uri":{"type":"string","description":"If defined, each inbound SMS is sent to this URL using HTTP POST, with the parameters in the request body.","example":"http://path/to/sms_forward_uri"},"@links":{"type":"object","properties":{"service_uri":{"type":"string","description":"service update link","example":"/services/61290081596"}}}}}},"components/schemas/CallbackBody":{"id":"components/schemas/CallbackBody","kind":"json-schema","title":"CallbackBody","data":{"type":"object","properties":{"request_id":{"type":"string","description":"Request Unique Id","example":"c9220015e2f48bc7cf4b38186a7b2025"},"custom_id":{"type":"string","description":"Custom Id submitted during service creation","example":"custom client id"},"status":{"type":"string","description":"Request status","enum":["completed","failed"],"example":"completed"},"message":{"type":"string","description":"Request status explained or error reason","example":"Request completed successfully"},"service_number":{"type":"string","description":"Provisioned service number, if any (E164 format)","example":"61290081596"},"answer_point":{"type":"string","description":"AnswerPoint submitted during service creation (E164 format)","example":"614201010100"}}}},"components/schemas/ServiceList":{"id":"components/schemas/ServiceList","kind":"json-schema","title":"ServiceList","data":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"type":"object","properties":{"@next":{"type":"string","description":"link to next 100 services","example":"/services/2"},"response":{"type":"array","items":{"$ref":"#/components/schemas/ServiceDetail"}}}}]}},"components/schemas/Template":{"id":"components/schemas/Template","kind":"json-schema","title":"Template","data":{"type":"object","properties":{"name":{"type":"string","description":"unique template name","example":"template name"},"type":{"type":"string","description":"template type","enum":["email","sms"],"example":"email"},"country":{"type":"string","description":"country the template is available for","example":"AU"}}}},"components/schemas/TemplateList":{"id":"components/schemas/TemplateList","kind":"json-schema","title":"TemplateList","data":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"type":"object","properties":{"response":{"type":"array","items":{"$ref":"#/components/schemas/Template"}}}}]}},"components/schemas/AIAgentDetail":{"id":"components/schemas/AIAgentDetail","kind":"json-schema","title":"AIAgentDetail","data":{"type":"object","description":"Configured AI Agent details.","properties":{"id":{"type":["integer","string"],"description":"Unique agent ID.","example":120},"agent_name":{"type":"string","description":"Friendly agent name; required on create and must remain populated on update.","example":"Reception AI","minLength":1},"voice":{"type":"string","description":"Voice key returned by List Agent Options; required on create and validated against current options after merging an update with stored details.","example":"alloy","enum":["alloy","ash","ballad","coral","echo","sage","shimmer","verse","marin","cedar"]},"agent_role":{"type":["string","null"],"description":"Role key returned by List Agent Options.","example":"receptionist","enum":["receptionist","support","sales","info","other",null]},"custom_agent_role":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for instruction generation when agent_role is other, and on update when the resulting role is other."},"children":[]}]}]}],"example":"After hours receptionist"},"business_type":{"type":["string","null"],"description":"Business type key returned by List Agent Options.","example":"realestate","enum":["professional","healthcare","realestate","legal","home","retail","restaurant","technology","education","automotive","governance","consulting","marketing","directory","oem","insurance","finance","other",null]},"custom_business_type":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for instruction generation when business_type is other, and on update when the resulting business type is other."},"children":[]}]}]}],"example":"Boat dealership"},"business_name":{"type":["string","null"],"description":"Business name used by the agent.","example":"Example Realty"},"business_description":{"type":["string","null"],"description":"Short business description; required on create and preview, and must remain populated on update.","example":"Real estate agency based in Sydney"},"contact_email":{"type":["string","null"],"description":"Business contact email; must be a valid email address when provided.","example":"reception@example.tld","format":"email"},"greeting":{"type":["string","null"],"description":"Stored greeting style key returned by List Agent Options; friendly is returned when greeting was omitted on create.","example":"friendly","enum":["formal","friendly","brief","warm",null]},"instructions":{"type":["string","null"],"description":"Agent conversational instructions, 4000 characters max. Omission or an empty value on create generates them; they must remain populated and are never regenerated on update.","example":"You are the Example Realty phone assistant.","maxLength":4000},"created_at":{"type":["string","null"],"description":"Agent creation date and time; may be null in an update response.","example":"2026-08-11T10:00:00+10:00","format":"date-time"},"@links":{"type":"object","properties":{"agent_uri":{"type":"string","description":"Agent detail link.","example":"/aiagents/155"}}}}}},"components/schemas/AIAgentDetailReply":{"id":"components/schemas/AIAgentDetailReply","kind":"json-schema","title":"AIAgentDetailReply","data":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"type":"object","properties":{"response":{"$ref":"#/components/schemas/AIAgentDetail"}}}]}},"components/schemas/AIAgentList":{"id":"components/schemas/AIAgentList","kind":"json-schema","title":"AIAgentList","data":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"type":"object","properties":{"response":{"type":"array","items":{"$ref":"#/components/schemas/AIAgentDetail"}}}}]}},"components/schemas/AIAgentForm":{"id":"components/schemas/AIAgentForm","kind":"json-schema","title":"AIAgentForm","data":{"type":"object","description":"Shared agent detail fields for create and update. Update changes only submitted fields; null clears optional details. Instructions are never regenerated on update.","properties":{"agent_name":{"type":"string","description":"Friendly agent name; required on create and must remain populated on update.","example":"Reception AI","minLength":1},"voice":{"type":"string","description":"Voice key returned by List Agent Options; required on create and validated against current options after merging an update with stored details.","example":"alloy","enum":["alloy","ash","ballad","coral","echo","sage","shimmer","verse","marin","cedar"]},"agent_role":{"type":["string","null"],"description":"Role key returned by List Agent Options. Required when instructions are generated.","example":"receptionist","enum":["receptionist","support","sales","info","other",null]},"custom_agent_role":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for instruction generation when agent_role is other, and on update when the resulting role is other."},"children":[]}]}]}],"example":"After hours receptionist"},"business_type":{"type":["string","null"],"description":"Business type key returned by List Agent Options. Required when instructions are generated.","example":"realestate","enum":["professional","healthcare","realestate","legal","home","retail","restaurant","technology","education","automotive","governance","consulting","marketing","directory","oem","insurance","finance","other",null]},"custom_business_type":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for instruction generation when business_type is other, and on update when the resulting business type is other."},"children":[]}]}]}],"example":"Boat dealership"},"business_name":{"type":["string","null"],"description":"Business name used by the agent. Required when instructions are generated.","example":"Example Realty"},"business_description":{"type":"string","description":"Short business description; required on create and preview, and cannot be cleared on update.","example":"Real estate agency based in Sydney","minLength":1},"contact_email":{"type":["string","null"],"description":"Business contact email; must be a valid email address when provided.","example":"reception@example.tld","format":"email"},"greeting":{"type":["string","null"],"description":"Greeting style key returned by List Agent Options; defaults to friendly when omitted on create, and null clears it on update.","example":"warm","enum":["formal","friendly","brief","warm",null]},"instructions":{"type":["string","null"],"description":"Agent conversational instructions, 4000 characters max. Omission or an empty value on create generates them; they cannot be cleared or regenerated on update.","example":"You are the Example Realty phone assistant.","maxLength":4000}}}},"components/schemas/AIAgentCreateForm":{"id":"components/schemas/AIAgentCreateForm","kind":"json-schema","title":"AIAgentCreateForm","data":{"allOf":[{"$ref":"#/components/schemas/AIAgentForm"},{"type":"object","required":["agent_name","voice","business_description"],"properties":{"greeting":{"default":"friendly"}},"if":{"not":{"required":["instructions"],"properties":{"instructions":{"type":"string","minLength":1}}}},"then":{"required":["agent_role","business_type","business_name"],"properties":{"agent_role":{"type":"string"},"business_type":{"type":"string"},"business_name":{"type":"string","minLength":1}},"allOf":[{"if":{"required":["agent_role"],"properties":{"agent_role":{"const":"other"}}},"then":{"required":["custom_agent_role"],"properties":{"custom_agent_role":{"type":"string","minLength":1}}}},{"if":{"required":["business_type"],"properties":{"business_type":{"const":"other"}}},"then":{"required":["custom_business_type"],"properties":{"custom_business_type":{"type":"string","minLength":1}}}}]}}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"agent_name, voice, and business_description are required. When instructions are omitted or empty, agent_role, business_type, and business_name are required; an other role or business type then requires its matching custom field. Greeting is optional and defaults to friendly when omitted."},"children":[]}]}]}]}},"components/schemas/AIAgentUpdateForm":{"id":"components/schemas/AIAgentUpdateForm","kind":"json-schema","title":"AIAgentUpdateForm","data":{"allOf":[{"$ref":"#/components/schemas/AIAgentForm"},{"type":"object","properties":{"instructions":{"type":"string","minLength":1}}}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submitted fields merge with existing details. The resulting agent_name, voice, business_description, and instructions must remain populated. A resulting other role or business type requires its matching custom field. Submitted agent_role, business_type, and greeting values are checked against their option lists; the resulting voice is always checked, even if omitted."},"children":[]}]}]}]}},"components/schemas/AIAgentInstructionsForm":{"id":"components/schemas/AIAgentInstructionsForm","kind":"json-schema","title":"AIAgentInstructionsForm","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details used to generate an instruction preview. agent_name, agent_role, business_type, business_name, and business_description are required; greeting is optional, while voice and instructions are ignored."},"children":[]}]}]}],"required":["agent_name","agent_role","business_type","business_name","business_description"],"allOf":[{"if":{"required":["agent_role"],"properties":{"agent_role":{"const":"other"}}},"then":{"required":["custom_agent_role"],"properties":{"custom_agent_role":{"type":"string","minLength":1}}}},{"if":{"required":["business_type"],"properties":{"business_type":{"const":"other"}}},"then":{"required":["custom_business_type"],"properties":{"custom_business_type":{"type":"string","minLength":1}}}}],"properties":{"agent_name":{"type":"string","description":"Friendly agent name; required for an instruction preview.","example":"Reception AI","minLength":1},"agent_role":{"type":"string","description":"Role key returned by List Agent Options. Required when instructions are generated.","example":"receptionist","enum":["receptionist","support","sales","info","other"]},"custom_agent_role":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when agent_role is other."},"children":[]}]}]}],"example":"After hours receptionist"},"business_type":{"type":"string","description":"Business type key returned by List Agent Options. Required when instructions are generated.","example":"realestate","enum":["professional","healthcare","realestate","legal","home","retail","restaurant","technology","education","automotive","governance","consulting","marketing","directory","oem","insurance","finance","other"]},"custom_business_type":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when business_type is other."},"children":[]}]}]}],"example":"Boat dealership"},"business_name":{"type":"string","description":"Business name used by the agent. Required when instructions are generated.","example":"Example Realty","minLength":1},"business_description":{"type":"string","description":"Short business description; required for an instruction preview.","example":"Real estate agency based in Sydney","minLength":1},"contact_email":{"type":["string","null"],"description":"Business contact email; must be a valid email address when provided.","example":"reception@example.tld","format":"email"},"greeting":{"type":["string","null"],"description":"Optional greeting style key returned by List Agent Options.","example":"warm","enum":["formal","friendly","brief","warm",null]}}}},"components/schemas/AIAgentReply":{"id":"components/schemas/AIAgentReply","kind":"json-schema","title":"AIAgentReply","data":{"allOf":[{"$ref":"#/components/schemas/GenericSuccess"},{"type":"object","properties":{"response":{"type":"object","properties":{"message":{"type":"string","description":"Confirmation message.","example":"Success"},"code":{"type":"number","description":"Confirmation code.","example":200},"agent":{"$ref":"#/components/schemas/AIAgentDetail"}}}}}]}},"components/schemas/AIAgentInstructionsReply":{"id":"components/schemas/AIAgentInstructionsReply","kind":"json-schema","title":"AIAgentInstructionsReply","data":{"allOf":[{"$ref":"#/components/schemas/GenericSuccess"},{"type":"object","properties":{"response":{"type":"object","properties":{"message":{"type":"string","description":"Confirmation message.","example":"Success"},"code":{"type":"number","description":"Confirmation code.","example":200},"instructions":{"type":"string","description":"Generated instructions.","example":"You are the Example Realty phone assistant."}}}}}]}},"components/schemas/AIAgentOption":{"id":"components/schemas/AIAgentOption","kind":"json-schema","title":"AIAgentOption","data":{"type":"object","required":["key","label"],"properties":{"key":{"type":"string","description":"Value to submit.","example":"alloy"},"label":{"type":"string","description":"Value to display.","example":"Alloy (neutral / clear)"},"formFields":{"type":"array","description":"Additional inputs for this option, such as the custom value required by other.","items":{"type":"object","properties":{"component":{"type":"string","example":"input"},"model":{"type":"string","example":"customAgentRole"},"props":{"type":"object","properties":{"label":{"type":"string","example":"Enter Agent Role"},"placeholder":{"type":"string","example":"e.g., Booking Assistant"}}}}}}}}},"components/schemas/AIAgentOptionsReply":{"id":"components/schemas/AIAgentOptionsReply","kind":"json-schema","title":"AIAgentOptionsReply","data":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"type":"object","properties":{"response":{"type":"object","properties":{"voices":{"type":"array","items":{"$ref":"#/components/schemas/AIAgentOption"},"description":"Values accepted by voice."},"assistantTypes":{"type":"array","items":{"$ref":"#/components/schemas/AIAgentOption"},"description":"Assistant type options returned for client interfaces."},"agentRoles":{"type":"array","items":{"$ref":"#/components/schemas/AIAgentOption"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values accepted by agent_role."},"children":[]}]}]}]},"personalAgentRoles":{"type":"array","items":{"$ref":"#/components/schemas/AIAgentOption"},"description":"Personal assistant role options returned for client interfaces."},"businessTypes":{"type":"array","items":{"$ref":"#/components/schemas/AIAgentOption"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values accepted by business_type."},"children":[]}]}]}]},"greetingStyles":{"type":"array","items":{"$ref":"#/components/schemas/AIAgentOption"},"description":"Values accepted by greeting."},"transferBehaviors":{"type":"array","items":{"$ref":"#/components/schemas/AIAgentOption"},"description":"Transfer behavior options returned for client interfaces."}}}}}]}},"components/schemas/AIAgentSetting":{"id":"components/schemas/AIAgentSetting","kind":"json-schema","title":"AIAgentSetting","data":{"type":"object","description":"Descriptor for one advanced setting.","properties":{"label":{"type":"string","description":"Setting label.","example":"Send Email"},"type":{"type":"string","description":"Value type.","example":"boolean","enum":["boolean","number","string"]},"component":{"type":"string","description":"Suggested input component.","example":"checkBox","enum":["checkBox","input","select"]},"default":{"description":"Value applied when submitted empty.","oneOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"null"}]},"description":{"type":"string","description":"What this setting does.","example":"Allows the AI to send emails during the call."},"value":{"description":"Value currently configured for this agent.","oneOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"null"}]},"min":{"type":"number","description":"Minimum accepted input value."},"max":{"type":"number","description":"Maximum accepted input value."},"conditional":{"type":"object","properties":{"field":{"type":"string","description":"Setting this one depends on.","example":"drop_on_silence"},"value":{"description":"Value the dependent setting must hold.","oneOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"null"}]}}},"options":{"type":"array","description":"Accepted select values.","items":{"type":"object","properties":{"label":{"type":"string","description":"Value to display.","example":"Server VAD - silence based"},"value":{"type":"string","description":"Value to submit.","example":"server_vad"}}}},"formFields":{"type":"array","description":"Additional fields enabled by a toggle.","items":{"type":"object","properties":{"component":{"type":"string","description":"Suggested input component.","example":"input"},"model":{"type":"string","description":"Field name to submit beside the toggle.","example":"scheduleLink"},"value":{"description":"Current field value.","oneOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"null"}]},"props":{"type":"object","properties":{"label":{"type":"string","description":"Display label.","example":"Schedule Link"},"placeholder":{"type":"string","description":"Display placeholder.","example":"e.g., https://calendly.com/your-link"}}},"type":{"type":"string","description":"Numeric type when applicable.","example":"number"},"min":{"type":"number"},"max":{"type":"number"},"default":{"type":"number"}}}},"assigned_route_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routes assigned to this agent; returned for find_next_folder."},"children":[]}]}]}],"items":{"type":"string"},"example":["298788","337622"]}}}},"components/schemas/AIAgentSettingsGroup":{"id":"components/schemas/AIAgentSettingsGroup","kind":"json-schema","title":"AIAgentSettingsGroup","data":{"type":"object","properties":{"label":{"type":"string","description":"Group label.","example":"Tools"},"type":{"type":"string","description":"Always group.","example":"group","enum":["group"]},"description":{"type":"string","description":"Group description.","example":"Available tools for the agent."},"children":{"type":"object","description":"Settings keyed by setting name.","additionalProperties":{"$ref":"#/components/schemas/AIAgentSetting"}}}}},"components/schemas/AIAgentAdvancedSettings":{"id":"components/schemas/AIAgentAdvancedSettings","kind":"json-schema","title":"AIAgentAdvancedSettings","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Advanced settings returned as field descriptors. find_next_folder is returned in transfer_call."},"children":[]}]}]}],"properties":{"tools":{"$ref":"#/components/schemas/AIAgentSettingsGroup"},"transfer_call":{"$ref":"#/components/schemas/AIAgentSettingsGroup"},"fine_tuning":{"$ref":"#/components/schemas/AIAgentSettingsGroup"}}}},"components/schemas/AIAgentAdvancedSettingsGetReply":{"id":"components/schemas/AIAgentAdvancedSettingsGetReply","kind":"json-schema","title":"AIAgentAdvancedSettingsGetReply","data":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"type":"object","properties":{"response":{"$ref":"#/components/schemas/AIAgentAdvancedSettings"}}}]}},"components/schemas/AIAgentRouteAssignment":{"id":"components/schemas/AIAgentRouteAssignment","kind":"json-schema","title":"AIAgentRouteAssignment","data":{"type":"object","required":["route_id"],"properties":{"route_id":{"type":"string","description":"Account menu or transfer route ID.","example":"298788"},"deleted":{"type":"boolean","description":"False assigns the route; true releases it.","default":false},"aiTags":{"type":"array","description":"Nonempty tags replace route tags. Omitted, empty, or blank-only tags keep existing tags.","items":{"type":"string"},"example":["sales","new-business"]}}}},"components/schemas/AIAgentAdvancedSettingsForm":{"id":"components/schemas/AIAgentAdvancedSettingsForm","kind":"json-schema","title":"AIAgentAdvancedSettingsForm","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUT replaces settings. Read current values, change what is needed, and submit all tools and fine_tuning fields."},"children":[]}]}]}],"properties":{"tools":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit all tool values. Omitted fields reset to defaults; find_next_folder is submitted here."},"children":[]}]}]}],"properties":{"scheduling":{"type":"boolean","description":"Lets the agent share a booking link.","default":false},"scheduleLink":{"type":["string","null"],"description":"Booking link; cleared when scheduling is false.","example":"https://calendly.com/example-realty","format":"uri"},"send_email":{"type":"boolean","description":"Allows the agent to send email notifications during calls.","default":false},"red_alert":{"type":"boolean","description":"Sends a webhook for urgent escalation.","default":false},"red_alert_webhook_url":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Urgent escalation webhook; cleared when red_alert is false."},"children":[]}]}]}],"example":"https://example.tld/webhook/red-alert","format":"uri"},"background_audio":{"type":"boolean","description":"Plays ambient background audio.","default":false},"office_noise_url":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Background audio URL; cleared when background_audio is false."},"children":[]}]}]}],"example":"https://example.tld/office.mp3","format":"uri"},"office_noise_volume":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Background audio volume; cleared when background_audio is false. Submitting 0 applies the default."},"children":[]}]}]}],"minimum":0,"maximum":1,"default":0.5},"call_outcome_webhook":{"type":"boolean","description":"Posts the call outcome when the call ends.","default":false},"calloutcome_webhook_url":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call outcome webhook; cleared when call_outcome_webhook is false."},"children":[]}]}]}],"example":"https://example.tld/webhook/call-outcome","format":"uri"},"find_next_folder":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lets the agent transfer calls to assigned routes. Returned in transfer_call; submitted in tools."},"children":[]}]}]}],"default":false}}},"fine_tuning":{"type":"object","description":"Submit all speech settings. Omitted fields reset to defaults.","properties":{"speed":{"type":"number","description":"Speech speed.","minimum":0.25,"maximum":1.5,"default":1},"temperature":{"type":"number","description":"Response creativity. Submitting 0 applies the default.","minimum":0,"maximum":2,"default":0.8},"no_barge_seconds":{"type":"number","description":"Seconds after call start during which the caller cannot interrupt; submitting 0 applies the default.","minimum":0,"maximum":60},"drop_on_silence":{"type":"boolean","description":"Automatically ends a call after caller silence.","default":false},"silence_prompt_ms":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Silence before asking “Sorry, are you there?” Cleared when drop_on_silence is false."},"children":[]}]}]}],"minimum":0,"maximum":30000},"silence_drop_ms":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum silence before ending a call. Cleared when drop_on_silence is false."},"children":[]}]}]}],"minimum":0,"maximum":60000},"vad_method":{"type":"string","description":"Voice activity detection method.","example":"server_vad","enum":["server_vad","semantic_vad"],"default":"server_vad"},"vad_prefix_padding_ms":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Audio kept before detected speech starts; server_vad only. Submitting 0 applies the default."},"children":[]}]}]}],"minimum":0,"maximum":5000,"default":300},"vad_silence_duration_ms":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Silence before speech is considered complete; server_vad only."},"children":[]}]}]}],"minimum":100,"maximum":10000,"default":700},"vad_threshold":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Speech against background noise sensitivity; server_vad only. Submitting 0 applies the default."},"children":[]}]}]}],"minimum":0,"maximum":1,"default":0.7},"vad_eagerness":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Eagerness to stop listening; semantic_vad only. Submitting 0 applies the default."},"children":[]}]}]}],"minimum":0,"maximum":1,"default":0.6},"avanser_bnum_in_instr":{"type":"boolean","description":"Adds the tracking number to the agent instructions.","default":false}}},"routes":{"type":"array","description":"Route assignments are merged: routes left out keep their current assignment.","items":{"$ref":"#/components/schemas/AIAgentRouteAssignment"}}}}},"components/schemas/AIAgentAdvancedSettingsReply":{"id":"components/schemas/AIAgentAdvancedSettingsReply","kind":"json-schema","title":"AIAgentAdvancedSettingsReply","data":{"allOf":[{"$ref":"#/components/schemas/GenericSuccess"},{"type":"object","properties":{"response":{"type":"object","properties":{"message":{"type":"string","description":"Confirmation message.","example":"Advanced settings saved successfully"},"code":{"type":"number","example":200},"advanced_settings":{"$ref":"#/components/schemas/AIAgentAdvancedSettings"}}}}}]}},"components/schemas/AIAgentAnswerPoint":{"id":"components/schemas/AIAgentAnswerPoint","kind":"json-schema","title":"AIAgentAnswerPoint","data":{"type":"object","properties":{"route_id":{"type":"string","description":"Menu answer point route ID.","example":"298788"},"name":{"type":"string","description":"Answer point name.","example":"AI Reception"},"action":{"type":"string","description":"Action type.","example":"xfr"},"type":{"type":["string","null"],"description":"Action type label; null when unknown.","example":"Transfer"},"target":{"type":"string","description":"Stored target using an AU, MY, or SG AI Agent prefix.","example":"+AIA-AIAGENTID155"}}}},"components/schemas/AIAgentAssignedNumber":{"id":"components/schemas/AIAgentAssignedNumber","kind":"json-schema","title":"AIAgentAssignedNumber","data":{"type":"object","properties":{"service_number":{"type":"string","description":"Assigned service number in E164 format; as stored for virtual numbers.","example":"61290081596"},"name":{"type":["string","null"],"description":"Service name, when present.","example":"Google Ads - Sydney"},"custom_id":{"type":["string","null"],"description":"Service custom ID, when present.","example":"GA-SYD"},"custom_group":{"type":["string","null"],"description":"Service custom group, when present.","example":"sydney-campaign"},"number_type":{"type":"string","description":"Number type; VIRT for a number provisioned without a type.","example":"GEO"},"country":{"type":"string","description":"Service country, ISO 3166-1 alpha-2.","example":"AU"},"campaign_start":{"type":["string","null"],"description":"Campaign start date, when present.","example":"2026-01-05","format":"date"},"answer_point":{"$ref":"#/components/schemas/AIAgentAnswerPoint"},"@links":{"type":"object","description":"Empty for a virtual number without an E164 form.","properties":{"service_uri":{"type":"string","description":"Service detail link, omitted for virtual numbers.","example":"/services/61290081596"}}}}}},"components/schemas/AIAgentAssignedNumberList":{"id":"components/schemas/AIAgentAssignedNumberList","kind":"json-schema","title":"AIAgentAssignedNumberList","data":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"type":"object","properties":{"response":{"type":"array","items":{"$ref":"#/components/schemas/AIAgentAssignedNumber"}}}}]}},"components/schemas/AIAgentDeleteReply":{"id":"components/schemas/AIAgentDeleteReply","kind":"json-schema","title":"AIAgentDeleteReply","data":{"allOf":[{"$ref":"#/components/schemas/GenericSuccess"},{"type":"object","properties":{"response":{"type":"object","properties":{"message":{"type":"string","description":"Confirmation message.","example":"Success"},"code":{"type":"number","example":200},"agent_id":{"type":"string","description":"Deleted agent ID.","example":"155"}}}}}]}},"components/schemas/TransferRoute":{"id":"components/schemas/TransferRoute","kind":"json-schema","title":"TransferRoute","data":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Route ID to submit as route_id in an advanced settings update."},"children":[]}]}]}],"example":"298788"},"name":{"type":"string","description":"Route name.","example":"Sales"},"action":{"type":"string","description":"Route action type.","example":"xfr"},"type":{"type":["string","null"],"description":"Action type label; null when unknown.","example":"Transfer"},"assignable":{"type":"boolean","description":"Whether this route type may be assigned to an AI Agent."},"ai_tags":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current route tags, # prefixed and shared by all assigned agents."},"children":[]}]}]}],"items":{"type":"string"},"example":["#sales","#new-business"]},"assigned_agent_ids":{"type":"array","description":"AI Agents currently transferring to this route.","items":{"type":"string"},"example":["155","177"]}}}},"components/schemas/TransferRouteList":{"id":"components/schemas/TransferRouteList","kind":"json-schema","title":"TransferRouteList","data":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"type":"object","properties":{"response":{"type":"array","items":{"$ref":"#/components/schemas/TransferRoute"}}}}]}},"schema_0":{"kind":"json-schema","data":{"type":"string","enum":["configuration","billing"],"default":"configuration"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"number"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"number","default":20},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"string","enum":["GEO","TOLLFREE","FREECALL","MOBILE"]},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"string","enum":["email","sms"],"default":"email"},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"string","pattern":"^[A-Za-z0-9_-]+$"},"id":"schema_7"}},"exampleStore":{"paths/~1accounts/get/responses/400/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Bad Request","code":400},"errors":{"account-id":"invalid account"}},"id":"paths/~1accounts/get/responses/400/content/application~1json/example"},"paths/~1accounts/get/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1accounts/get/responses/401/content/application~1json/example"},"paths/~1accounts/get/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1accounts/get/responses/500/content/application~1json/example"},"paths/~1accounts/post/responses/400/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"POST","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Bad Request","code":400},"errors":{"request":"invalid request"}},"id":"paths/~1accounts/post/responses/400/content/application~1json/example"},"paths/~1accounts/post/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1accounts/post/responses/401/content/application~1json/example"},"paths/~1accounts/post/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1accounts/post/responses/500/content/application~1json/example"},"paths/~1numbers?country={country}&location={location}/get/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1numbers?country={country}&location={location}/get/responses/401/content/application~1json/example"},"paths/~1numbers?country={country}&location={location}/get/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1numbers?country={country}&location={location}/get/responses/500/content/application~1json/example"},"paths/~1numbers?country={country}&lat={lat}&lng={lng}/get/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1numbers?country={country}&lat={lat}&lng={lng}/get/responses/401/content/application~1json/example"},"paths/~1numbers?country={country}&lat={lat}&lng={lng}/get/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1numbers?country={country}&lat={lat}&lng={lng}/get/responses/500/content/application~1json/example"},"paths/~1numbers?country={country}&number={number}/get/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1numbers?country={country}&number={number}/get/responses/401/content/application~1json/example"},"paths/~1numbers?country={country}&number={number}/get/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1numbers?country={country}&number={number}/get/responses/500/content/application~1json/example"},"paths/~1numbers?country={country}&number_type={number_type}/get/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1numbers?country={country}&number_type={number_type}/get/responses/401/content/application~1json/example"},"paths/~1numbers?country={country}&number_type={number_type}/get/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1numbers?country={country}&number_type={number_type}/get/responses/500/content/application~1json/example"},"paths/~1numbers?szu={szu}/get/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1numbers?szu={szu}/get/responses/401/content/application~1json/example"},"paths/~1numbers?szu={szu}/get/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1numbers?szu={szu}/get/responses/500/content/application~1json/example"},"paths/~1requests/post/requestBody/content/application~1json/examples/transfer":{"value":{"name":"TAPI Transfer EXAMPLE","custom_id":"tapi-transfer-example-1","service_number":{"country":"AU","search_type":"number_type","number_type":"MOBILE"},"service":{"type":"transfer","answer_point_name":"TAPI answer point EXAMPLE #1","answer_point":"61420123123","call_whisper":"https://example.tld/audio/call_whisper.wav","voicemail":"https://example.tld/audio/voicemail.wav","record_call":false,"transcription":{"transcribe_call":true,"enable_pci_redaction":true,"enable_pii_redaction":true},"call_reporting":{"report":"none"}},"call_uri":"http://example.tld/debug.php?call-uri","sms_forward_uri":"http://example.tld/debug.php?sms_forward_uri","callback_uri":"http://example.tld/debug.php?callback_uri"},"key":"transfer","summary":"new transfer service","id":"paths/~1requests/post/requestBody/content/application~1json/examples/transfer"},"paths/~1requests/post/requestBody/content/application~1json/examples/transferToAiAgent":{"value":{"name":"TAPI AI Agent transfer","service_number":{"country":"AU","search_type":"number_type","number_type":"mobile"},"service":{"type":"transfer","answer_point_name":"AI Reception","answer_point":"+AIA-AIAGENTID155","record_call":false}},"key":"transferToAiAgent","summary":"new transfer service answered by an AI Agent","id":"paths/~1requests/post/requestBody/content/application~1json/examples/transferToAiAgent"},"paths/~1requests/post/requestBody/content/application~1json/examples/voicemail":{"value":{"name":"TAPI Voicemail EXAMPLE","custom_id":"tapi-voicemail-example-1","service_number":{"country":"AU","search_type":"number_type","number_type":"MOBILE"},"service":{"type":"voicemail","answer_point_name":"TAPI answer point EXAMPLE #2","voicemail":"https://example.tld/audio/voicemail.mp3","call_reporting":{"report":"missed","email":{"subject":"call for Voicemail","email_to":["no-reply@avanser.com.au"],"template":"html_email_template"},"sms":{"mobile":"61420123123","template":"text_sms_template"}}},"call_uri":"http://example.tld/debug.php?call-uri","sms_forward_uri":"http://example.tld/debug.php?sms_forward_uri","callback_uri":"http://example.tld/debug.php?callback_uri"},"key":"voicemail","summary":"new voicemail service","id":"paths/~1requests/post/requestBody/content/application~1json/examples/voicemail"},"paths/~1requests/post/requestBody/content/application~1json/examples/prompt":{"value":{"name":"TAPI Prompt EXAMPLE","custom_id":"tapi-prompt-example-1","service_number":{"country":"AU","search_type":"number_type","number_type":"MOBILE"},"service":{"type":"prompt","answer_point_name":"TAPI answer point EXAMPLE #3","call_greeting":"https://example.tld/audio/call_greeting.wav"},"call_reporting":{"report":"missed","email":{"subject":"call for Prompt","email_to":["no-reply@avanser.com.au"],"template":"html_email_template"},"sms":{"mobile":"61420123123","template":"text_sms_template"}},"call_uri":"http://example.tld/debug.php?call-uri","sms_forward_uri":"http://example.tld/debug.php?sms_forward_uri","callback_uri":"http://example.tld/debug.php?callback_uri"},"key":"prompt","summary":"new prompt service","id":"paths/~1requests/post/requestBody/content/application~1json/examples/prompt"},"paths/~1requests/post/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1requests/post/responses/401/content/application~1json/example"},"paths/~1requests/post/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1requests/post/responses/500/content/application~1json/example"},"paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/disableCallReporting":{"value":{"call_reporting":{"report":"none"}},"key":"disableCallReporting","summary":"Disable call_reporting service","id":"paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/disableCallReporting"},"paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/updateAnswerPointName":{"value":{"service":{"answer_point_name":"Sidney Office New"}},"key":"updateAnswerPointName","summary":"Update answer_point_name","id":"paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/updateAnswerPointName"},"paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/configureTranscription":{"value":{"service":{"transcription":{"transcribe_call":true,"enable_pci_redaction":true,"enable_pii_redaction":true}}},"key":"configureTranscription","summary":"Enable transcription and configure redaction","id":"paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/configureTranscription"},"paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/assignToAiAgent":{"value":{"service":{"answer_point":"+AIA-AIAGENTID155"}},"key":"assignToAiAgent","summary":"Assign a transfer service to an AI Agent","id":"paths/~1services~1{service_number}~1/post/requestBody/content/application~1json/examples/assignToAiAgent"},"paths/~1services~1{service_number}~1/post/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1services~1{service_number}~1/post/responses/401/content/application~1json/example"},"paths/~1services~1{service_number}~1/post/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1services~1{service_number}~1/post/responses/500/content/application~1json/example"},"paths/~1services~1{service_number}~1/delete/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1services~1{service_number}~1/delete/responses/401/content/application~1json/example"},"paths/~1services~1{service_number}~1/delete/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1services~1{service_number}~1/delete/responses/500/content/application~1json/example"},"paths/~1templates/get/responses/400/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"POST","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Bad Request","code":400},"errors":{"request":"invalid request"}},"id":"paths/~1templates/get/responses/400/content/application~1json/example"},"paths/~1templates/get/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1templates/get/responses/401/content/application~1json/example"},"paths/~1templates/get/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1templates/get/responses/500/content/application~1json/example"},"paths/~1templates/post/requestBody/content/text~1html/example":{"value":"<html>\n    <body>\n        New Call for your service `__adname__` (`__bnum__`) at `__dateTime__`.\n\n        We tried to forward the call to `__outnum__`.\n\n        Download the voicemail at `__LINK__`\n    </body>\n</html>\n","id":"paths/~1templates/post/requestBody/content/text~1html/example"},"paths/~1templates/post/responses/400/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"POST","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Bad Request","code":400},"errors":{"request":"invalid request"}},"id":"paths/~1templates/post/responses/400/content/application~1json/example"},"paths/~1templates/post/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1templates/post/responses/401/content/application~1json/example"},"paths/~1templates/post/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1templates/post/responses/500/content/application~1json/example"},"paths/~1templates/delete/responses/400/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"DELETE","path":"/templates","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Template is in use","code":400},"errors":{"name":"template is in use"}},"id":"paths/~1templates/delete/responses/400/content/application~1json/example"},"paths/~1templates/delete/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1templates/delete/responses/401/content/application~1json/example"},"paths/~1templates/delete/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1templates/delete/responses/500/content/application~1json/example"},"paths/~1templates?name={name}&country={country}/get/responses/400/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"POST","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Bad Request","code":400},"errors":{"request":"invalid request"}},"id":"paths/~1templates?name={name}&country={country}/get/responses/400/content/application~1json/example"},"paths/~1templates?name={name}&country={country}/get/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1templates?name={name}&country={country}/get/responses/401/content/application~1json/example"},"paths/~1templates?name={name}&country={country}/get/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1templates?name={name}&country={country}/get/responses/500/content/application~1json/example"},"paths/~1aiagents/get/responses/200/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":"1234","request":{"api-version":"v1","method":"GET","path":"/v1/aiagents","time":"2026-10-07T20:46:29+11:00","ms":"1.710"}},"response":[{"id":120,"agent_name":"Education Assistant","agent_role":"info","custom_agent_role":null,"business_type":"education","custom_business_type":null,"business_name":"Example Education","business_description":"Answers course questions and helps book consultations.","contact_email":"info@example.tld","greeting":"friendly","voice":"alloy","instructions":"Answer questions about education services and help callers book a consultation.","created_at":"2026-01-30T05:34:00.000Z","@links":{"agent_uri":"/aiagents/120"}},{"id":223,"agent_name":"Dental Reception Assistant","agent_role":"other","custom_agent_role":"reception dentistry assistant","business_type":"other","custom_business_type":"dental practice","business_name":"Example Dental","business_description":"Dental practice answering appointment and general enquiry calls.","contact_email":null,"greeting":"friendly","voice":"echo","instructions":"Greet callers, answer general questions, and help schedule dental appointments.","created_at":"2026-10-07T09:44:47.000Z","@links":{"agent_uri":"/aiagents/223"}}]},"id":"paths/~1aiagents/get/responses/200/content/application~1json/example"},"paths/~1aiagents/get/responses/400/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"POST","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Bad Request","code":400},"errors":{"request":"invalid request"}},"id":"paths/~1aiagents/get/responses/400/content/application~1json/example"},"paths/~1aiagents/get/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1aiagents/get/responses/401/content/application~1json/example"},"paths/~1aiagents/get/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1aiagents/get/responses/500/content/application~1json/example"},"paths/~1aiagents/get/responses/502/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"AI Agent service error","code":502},"errors":{"description":"The AI Agent service returned an error","code":"ai_agent_service_error"}},"id":"paths/~1aiagents/get/responses/502/content/application~1json/example"},"paths/~1aiagents/get/responses/503/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"AI Agent service is not configured","code":503},"errors":{"description":"The AI Agent service is not configured for this account","code":"ai_agent_service_not_configured"}},"id":"paths/~1aiagents/get/responses/503/content/application~1json/example"},"paths/~1aiagents/post/requestBody/content/application~1json/example":{"value":{"agent_name":"Reception AI","voice":"alloy","agent_role":"receptionist","business_type":"realestate","business_name":"Example Realty","business_description":"Real estate agency based in Sydney","contact_email":"reception@example.tld"},"id":"paths/~1aiagents/post/requestBody/content/application~1json/example"},"paths/~1aiagents/post/responses/200/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":"1234","request":{"api-version":"v1","method":"POST","path":"/v1/aiagents","time":"2026-10-07T20:46:29+11:00","ms":"7.015"}},"response":{"message":"Success","code":200,"agent":{"id":223,"agent_name":"Dental Reception Assistant","agent_role":"other","custom_agent_role":"reception dentistry assistant","business_type":"other","custom_business_type":"dental practice","business_name":"Example Dental","business_description":"Dental practice answering appointment and general enquiry calls.","contact_email":null,"greeting":"friendly","voice":"echo","instructions":"Greet callers, answer general questions, and help schedule dental appointments.","created_at":"2026-10-07T09:44:47.000Z","@links":{"agent_uri":"/aiagents/223"}}}},"id":"paths/~1aiagents/post/responses/200/content/application~1json/example"},"paths/~1aiagents/post/responses/400/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"POST","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Bad Request","code":400},"errors":{"agent_name":"required"}},"id":"paths/~1aiagents/post/responses/400/content/application~1json/example"},"paths/~1aiagents/post/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1aiagents/post/responses/401/content/application~1json/example"},"paths/~1aiagents/post/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1aiagents/post/responses/500/content/application~1json/example"},"paths/~1aiagents/post/responses/502/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"AI Agent service error","code":502},"errors":{"description":"The AI Agent service returned an error","code":"ai_agent_service_error"}},"id":"paths/~1aiagents/post/responses/502/content/application~1json/example"},"paths/~1aiagents/post/responses/503/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"AI Agent service is not configured","code":503},"errors":{"description":"The AI Agent service is not configured for this account","code":"ai_agent_service_not_configured"}},"id":"paths/~1aiagents/post/responses/503/content/application~1json/example"},"paths/~1aiagents~1options/get/responses/200/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":"1234","request":{"api-version":"v1","method":"GET","path":"/v1/aiagents/options","time":"2026-10-07T20:46:29+11:00","ms":"1.852"}},"response":{"voices":[{"label":"Alloy (neutral / clear)","key":"alloy"},{"label":"Ash (soft / intimate)","key":"ash"},{"label":"Ballad (melodic / storytelling)","key":"ballad"},{"label":"Coral (bright / engaging)","key":"coral"},{"label":"Echo (bold / resonant)","key":"echo"},{"label":"Sage (calm / thoughtful)","key":"sage"},{"label":"Shimmer (light / radiant)","key":"shimmer"},{"label":"Verse (poetic / lyrical)","key":"verse"},{"label":"Marin (smooth / flowing)","key":"marin"},{"label":"Cedar (warm / grounded)","key":"cedar"}],"assistantTypes":[{"label":"Personal Assistant","key":"personal"},{"label":"Business Assistant","key":"business"}],"businessTypes":[{"label":"Professional Services","key":"professional"},{"label":"Healthcare","key":"healthcare"},{"label":"Real Estate","key":"realestate"},{"label":"Legal Services","key":"legal"},{"label":"Home Services","key":"home"},{"label":"Retail/E-commerce","key":"retail"},{"label":"Restaurant/Food","key":"restaurant"},{"label":"Technology","key":"technology"},{"label":"Education","key":"education"},{"label":"Automotive","key":"automotive"},{"label":"Governance","key":"governance"},{"label":"Consulting","key":"consulting"},{"label":"Marketing","key":"marketing"},{"label":"Directory","key":"directory"},{"label":"OEM (Original Equipment Manufacturer)","key":"oem"},{"label":"Insurance","key":"insurance"},{"label":"Finance","key":"finance"},{"label":"Other","key":"other","formFields":[{"component":"input","model":"customBusinessType","props":{"label":"Enter Business Type","placeholder":"e.g., Transportation services"}}]}],"personalAgentRoles":[{"label":"Personal Assistant","key":"personal_assistant"},{"label":"Call Screener","key":"call_screener"},{"label":"Message Taker","key":"message_taker"}],"agentRoles":[{"label":"Receptionist/Assistant","key":"receptionist"},{"label":"Customer Support","key":"support"},{"label":"Sales Assistant","key":"sales"},{"label":"Information Provider","key":"info"},{"label":"Other","key":"other","formFields":[{"component":"input","model":"customAgentRole","props":{"label":"Enter Agent Role","placeholder":"e.g., Booking Assistant"}}]}],"greetingStyles":[{"label":"Professional & Formal","key":"formal"},{"label":"Friendly & Casual","key":"friendly"},{"label":"Brief & Direct","key":"brief"},{"label":"Warm & Personal","key":"warm"}],"transferBehaviors":[{"label":"Transfer immediately for urgent matters","key":"urgent_immediate"},{"label":"Try to help first, then transfer","key":"help_first"},{"label":"Only transfer during business hours","key":"business_hours"}]}},"id":"paths/~1aiagents~1options/get/responses/200/content/application~1json/example"},"paths/~1aiagents~1options/get/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1aiagents~1options/get/responses/401/content/application~1json/example"},"paths/~1aiagents~1options/get/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1aiagents~1options/get/responses/500/content/application~1json/example"},"paths/~1aiagents~1options/get/responses/502/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"AI Agent service error","code":502},"errors":{"description":"The AI Agent service returned an error","code":"ai_agent_service_error"}},"id":"paths/~1aiagents~1options/get/responses/502/content/application~1json/example"},"paths/~1aiagents~1options/get/responses/503/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"AI Agent service is not configured","code":503},"errors":{"description":"The AI Agent service is not configured for this account","code":"ai_agent_service_not_configured"}},"id":"paths/~1aiagents~1options/get/responses/503/content/application~1json/example"},"paths/~1aiagents~1preview-instruction/post/requestBody/content/application~1json/example":{"value":{"agent_name":"Reception AI","agent_role":"receptionist","business_type":"realestate","business_name":"Example Realty","business_description":"Real estate agency based in Sydney","contact_email":"reception@example.tld","greeting":"warm"},"id":"paths/~1aiagents~1preview-instruction/post/requestBody/content/application~1json/example"},"paths/~1aiagents~1preview-instruction/post/responses/200/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":"1234","request":{"api-version":"v1","method":"POST","path":"/v1/aiagents/preview-instruction","time":"2026-10-07T20:46:29+11:00","ms":"10.389"}},"response":{"message":"Success","code":200,"instructions":"### Role and Responsibilities\n- Answer callers as a reception assistant.\n- Help with appointments and general questions."}},"id":"paths/~1aiagents~1preview-instruction/post/responses/200/content/application~1json/example"},"paths/~1aiagents~1preview-instruction/post/responses/400/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"POST","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Bad Request","code":400},"errors":{"request":"invalid request"}},"id":"paths/~1aiagents~1preview-instruction/post/responses/400/content/application~1json/example"},"paths/~1aiagents~1preview-instruction/post/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1aiagents~1preview-instruction/post/responses/401/content/application~1json/example"},"paths/~1aiagents~1preview-instruction/post/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1aiagents~1preview-instruction/post/responses/500/content/application~1json/example"},"paths/~1aiagents~1preview-instruction/post/responses/502/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"AI Agent service error","code":502},"errors":{"description":"The AI Agent service returned an error","code":"ai_agent_service_error"}},"id":"paths/~1aiagents~1preview-instruction/post/responses/502/content/application~1json/example"},"paths/~1aiagents~1preview-instruction/post/responses/503/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"AI Agent service is not configured","code":503},"errors":{"description":"The AI Agent service is not configured for this account","code":"ai_agent_service_not_configured"}},"id":"paths/~1aiagents~1preview-instruction/post/responses/503/content/application~1json/example"},"paths/~1aiagents~1{agent_id}/get/responses/200/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":"1234","request":{"api-version":"v1","method":"GET","path":"/v1/aiagents/120","time":"2026-10-07T20:46:29+11:00","ms":"1.731"}},"response":{"id":120,"agent_name":"Education Assistant","agent_role":"info","custom_agent_role":null,"business_type":"education","custom_business_type":null,"business_name":"Example Education","business_description":"Answers course questions and helps book consultations.","contact_email":"info@example.tld","greeting":"friendly","voice":"alloy","instructions":"Answer questions about education services and help callers book a consultation.","created_at":"2026-01-30T05:34:00.000Z","@links":{"agent_uri":"/aiagents/120"}}},"id":"paths/~1aiagents~1{agent_id}/get/responses/200/content/application~1json/example"},"paths/~1aiagents~1{agent_id}/get/responses/400/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents/{agent_id}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Bad Request","code":400},"errors":{"agent_id":"invalid"}},"id":"paths/~1aiagents~1{agent_id}/get/responses/400/content/application~1json/example"},"paths/~1aiagents~1{agent_id}/get/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1aiagents~1{agent_id}/get/responses/401/content/application~1json/example"},"paths/~1aiagents~1{agent_id}/get/responses/404/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents/{agent_id}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Not Found","code":404},"errors":{"agent_id":"agent not found"}},"id":"paths/~1aiagents~1{agent_id}/get/responses/404/content/application~1json/example"},"paths/~1aiagents~1{agent_id}/get/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1aiagents~1{agent_id}/get/responses/500/content/application~1json/example"},"paths/~1aiagents~1{agent_id}/get/responses/502/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"AI Agent service error","code":502},"errors":{"description":"The AI Agent service returned an error","code":"ai_agent_service_error"}},"id":"paths/~1aiagents~1{agent_id}/get/responses/502/content/application~1json/example"},"paths/~1aiagents~1{agent_id}/get/responses/503/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"AI Agent service is not configured","code":503},"errors":{"description":"The AI Agent service is not configured for this account","code":"ai_agent_service_not_configured"}},"id":"paths/~1aiagents~1{agent_id}/get/responses/503/content/application~1json/example"},"paths/~1aiagents~1{agent_id}/put/requestBody/content/application~1json/examples/greeting":{"value":{"greeting":"warm"},"key":"greeting","summary":"Update the agent greeting","id":"paths/~1aiagents~1{agent_id}/put/requestBody/content/application~1json/examples/greeting"},"paths/~1aiagents~1{agent_id}/put/requestBody/content/application~1json/examples/instructions":{"value":{"instructions":"You are the Example Realty phone assistant. Answer politely and collect the caller details."},"key":"instructions","summary":"Update the agent instructions","id":"paths/~1aiagents~1{agent_id}/put/requestBody/content/application~1json/examples/instructions"},"paths/~1aiagents~1{agent_id}/put/responses/200/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":"1234","request":{"api-version":"v1","method":"PUT","path":"/v1/aiagents/120","time":"2026-10-07T20:46:29+11:00","ms":"3.150"}},"response":{"message":"Success","code":200,"agent":{"id":120,"agent_name":"Education Assistant","agent_role":"info","custom_agent_role":null,"business_type":"education","custom_business_type":null,"business_name":"Example Education","business_description":"Answers course questions and helps book consultations.","contact_email":"info@example.tld","greeting":"friendly","voice":"alloy","instructions":"Answer questions about education services and help callers book a consultation.","created_at":null,"@links":{"agent_uri":"/aiagents/120"}}}},"id":"paths/~1aiagents~1{agent_id}/put/responses/200/content/application~1json/example"},"paths/~1aiagents~1{agent_id}/put/responses/400/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"POST","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Bad Request","code":400},"errors":{"agent_name":"required"}},"id":"paths/~1aiagents~1{agent_id}/put/responses/400/content/application~1json/example"},"paths/~1aiagents~1{agent_id}/put/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1aiagents~1{agent_id}/put/responses/401/content/application~1json/example"},"paths/~1aiagents~1{agent_id}/put/responses/404/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents/{agent_id}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Not Found","code":404},"errors":{"agent_id":"agent not found"}},"id":"paths/~1aiagents~1{agent_id}/put/responses/404/content/application~1json/example"},"paths/~1aiagents~1{agent_id}/put/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1aiagents~1{agent_id}/put/responses/500/content/application~1json/example"},"paths/~1aiagents~1{agent_id}/put/responses/502/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"AI Agent service error","code":502},"errors":{"description":"The AI Agent service returned an error","code":"ai_agent_service_error"}},"id":"paths/~1aiagents~1{agent_id}/put/responses/502/content/application~1json/example"},"paths/~1aiagents~1{agent_id}/put/responses/503/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"AI Agent service is not configured","code":503},"errors":{"description":"The AI Agent service is not configured for this account","code":"ai_agent_service_not_configured"}},"id":"paths/~1aiagents~1{agent_id}/put/responses/503/content/application~1json/example"},"paths/~1aiagents~1{agent_id}/delete/responses/400/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":"1234","request":{"api-version":"v1","method":"DELETE","path":"/v1/aiagents/120","time":"2026-10-07T23:09:50+11:00","ms":"4.580"}},"error":{"message":"Bad Request","code":400},"errors":{"agent_id":"agent has assigned tracking numbers"}},"id":"paths/~1aiagents~1{agent_id}/delete/responses/400/content/application~1json/example"},"paths/~1aiagents~1{agent_id}/delete/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1aiagents~1{agent_id}/delete/responses/401/content/application~1json/example"},"paths/~1aiagents~1{agent_id}/delete/responses/404/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents/{agent_id}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Not Found","code":404},"errors":{"agent_id":"agent not found"}},"id":"paths/~1aiagents~1{agent_id}/delete/responses/404/content/application~1json/example"},"paths/~1aiagents~1{agent_id}/delete/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1aiagents~1{agent_id}/delete/responses/500/content/application~1json/example"},"paths/~1aiagents~1{agent_id}/delete/responses/502/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"AI Agent service error","code":502},"errors":{"description":"The AI Agent service returned an error","code":"ai_agent_service_error"}},"id":"paths/~1aiagents~1{agent_id}/delete/responses/502/content/application~1json/example"},"paths/~1aiagents~1{agent_id}/delete/responses/503/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"AI Agent service is not configured","code":503},"errors":{"description":"The AI Agent service is not configured for this account","code":"ai_agent_service_not_configured"}},"id":"paths/~1aiagents~1{agent_id}/delete/responses/503/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/200/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":"1234","request":{"api-version":"v1","method":"GET","path":"/v1/aiagents/120/advanced-settings","time":"2026-10-07T20:46:29+11:00","ms":"2.127"}},"response":{"tools":{"label":"Tools","type":"group","description":"Available tools for the agent","children":{"scheduling":{"label":"Add Calendar","type":"boolean","component":"checkBox","default":false,"description":"","value":true,"formFields":[{"component":"input","model":"scheduleLink","value":"https://calendly.com/example","props":{"label":"Schedule Link","placeholder":"e.g., https://calendly.com/your-link"}}]},"send_email":{"label":"Send Email","type":"boolean","component":"checkBox","default":false,"description":"Allows the AI to send emails during the call.","value":true},"red_alert":{"label":"Enable Red Alert Webhook","type":"boolean","component":"checkBox","default":false,"description":"Send a red alert webhook when urgent escalation is required","value":true,"formFields":[{"component":"input","model":"red_alert_webhook_url","value":"https://example.tld/webhook","props":{"label":"Red Alert Webhook URL","placeholder":"e.g., https://your-domain.com/webhook"}}]},"background_audio":{"label":"Enable Background Audio","type":"boolean","component":"checkBox","default":false,"description":"Play ambient background audio during the conversation.","value":false,"formFields":[{"component":"input","model":"office_noise_url","value":null,"props":{"label":"Background Audio URL","placeholder":"e.g., https://example.com/audio.mp3"}},{"component":"input","model":"office_noise_volume","value":0.5,"props":{"label":"Background Audio Volume","placeholder":"Enter a value between 0 and 1 (e.g., 0.3)"},"type":"number","min":0,"max":1,"default":0.5}]},"call_outcome_webhook":{"label":"Enable Call Outcome Webhook","type":"boolean","component":"checkBox","default":false,"description":"Send call outcome to webhook after call ends","value":false,"formFields":[{"component":"input","model":"calloutcome_webhook_url","value":null,"props":{"label":"Call Outcome Webhook URL","placeholder":"e.g., https://your-domain.com/webhook"}}]}}},"transfer_call":{"label":"Transfer call","type":"group","description":"","children":{"find_next_folder":{"label":"Transfer calls","type":"boolean","component":"checkBox","default":false,"description":"","value":true,"assigned_route_ids":[]}}},"fine_tuning":{"label":"Speech Fine-tuning","type":"group","description":"","children":{"speed":{"label":"Speech Speed","type":"number","component":"input","default":1,"description":"Controls how fast the AI speaks.","value":1,"min":0.25,"max":1.5},"temperature":{"label":"Response Creativity","type":"number","component":"input","default":0.8,"description":"Controls response randomness.","value":0.7,"min":0,"max":2},"no_barge_seconds":{"label":"No Barge Seconds","type":"number","component":"input","default":null,"description":"Prevents callers from interrupting the greeting.","value":2,"min":0,"max":60},"drop_on_silence":{"label":"Drop Call on Silence","type":"boolean","component":"checkBox","default":false,"description":"End calls after extended caller silence.","value":true},"silence_prompt_ms":{"label":"Silence Prompt (ms)","type":"number","component":"input","default":null,"description":"Silence before asking whether the caller is still there.","value":1000,"conditional":{"field":"drop_on_silence","value":true},"min":0,"max":30000},"silence_drop_ms":{"label":"Silence Drop (ms)","type":"number","component":"input","default":null,"description":"Maximum silence before ending a call.","value":null,"conditional":{"field":"drop_on_silence","value":true},"min":0,"max":60000},"vad_method":{"label":"Voice Activity Detection Method","type":"string","component":"select","default":"server_vad","description":"Audio segmentation method.","value":"server_vad","options":[{"label":"Server VAD (silence-based)","value":"server_vad"},{"label":"Semantic VAD (content-based)","value":"semantic_vad"}]},"vad_prefix_padding_ms":{"label":"Voice Detection Prefix Padding (ms)","type":"number","component":"input","default":300,"description":"Audio kept before detected speech starts.","value":300,"conditional":{"field":"vad_method","value":"server_vad"},"min":0,"max":5000},"vad_silence_duration_ms":{"label":"Silence Duration Before Stop (ms)","type":"number","component":"input","default":700,"description":"Silence before speech is considered complete.","value":500,"conditional":{"field":"vad_method","value":"server_vad"},"min":100,"max":10000},"vad_threshold":{"label":"Voice Activity Detection Threshold","type":"number","component":"input","default":0.7,"description":"Sensitivity for detecting speech against background noise.","value":0.1,"conditional":{"field":"vad_method","value":"server_vad"},"min":0,"max":1},"vad_eagerness":{"label":"VAD Eagerness","type":"number","component":"input","default":0.6,"description":"How eager semantic VAD is to stop listening.","value":0.1,"conditional":{"field":"vad_method","value":"semantic_vad"},"min":0,"max":1},"avanser_bnum_in_instr":{"label":"Inject tracking number into AI instructions","type":"boolean","component":"checkBox","default":false,"description":"Inserts the tracking number into AI instructions.","value":false}}}}},"id":"paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/200/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/400/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents/{agent_id}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Bad Request","code":400},"errors":{"agent_id":"invalid"}},"id":"paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/400/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/401/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/404/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents/{agent_id}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Not Found","code":404},"errors":{"agent_id":"agent not found"}},"id":"paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/404/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/500/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/502/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"AI Agent service error","code":502},"errors":{"description":"The AI Agent service returned an error","code":"ai_agent_service_error"}},"id":"paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/502/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/503/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"AI Agent service is not configured","code":503},"errors":{"description":"The AI Agent service is not configured for this account","code":"ai_agent_service_not_configured"}},"id":"paths/~1aiagents~1{agent_id}~1advanced-settings/get/responses/503/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1advanced-settings/put/requestBody/content/application~1json/example":{"value":{"tools":{"scheduling":true,"scheduleLink":"https://calendly.com/example-realty","send_email":false,"red_alert":true,"red_alert_webhook_url":"https://example.tld/webhook/red-alert","background_audio":false,"office_noise_url":null,"office_noise_volume":0.5,"call_outcome_webhook":true,"calloutcome_webhook_url":"https://example.tld/webhook/call-outcome","find_next_folder":true},"fine_tuning":{"speed":1,"temperature":0.7,"no_barge_seconds":2,"drop_on_silence":true,"silence_prompt_ms":1000,"silence_drop_ms":3000,"vad_method":"server_vad","vad_prefix_padding_ms":300,"vad_silence_duration_ms":500,"vad_threshold":0.1,"vad_eagerness":0.6,"avanser_bnum_in_instr":false},"routes":[{"route_id":"298788","aiTags":["sales","new-business"]},{"route_id":"337622","deleted":true}]},"id":"paths/~1aiagents~1{agent_id}~1advanced-settings/put/requestBody/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/200/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":"1234","request":{"api-version":"v1","method":"PUT","path":"/v1/aiagents/120/advanced-settings","time":"2026-10-07T20:46:29+11:00","ms":"4.984"}},"response":{"message":"Advanced settings saved successfully","code":200,"advanced_settings":{"tools":{"label":"Tools","type":"group","description":"Available tools for the agent","children":{"scheduling":{"label":"Add Calendar","type":"boolean","component":"checkBox","default":false,"description":"","value":true,"formFields":[{"component":"input","model":"scheduleLink","value":"https://calendly.com/example","props":{"label":"Schedule Link","placeholder":"e.g., https://calendly.com/your-link"}}]},"send_email":{"label":"Send Email","type":"boolean","component":"checkBox","default":false,"description":"Allows the AI to send emails during the call.","value":true},"red_alert":{"label":"Enable Red Alert Webhook","type":"boolean","component":"checkBox","default":false,"description":"Send a red alert webhook when urgent escalation is required","value":true,"formFields":[{"component":"input","model":"red_alert_webhook_url","value":"https://example.tld/webhook","props":{"label":"Red Alert Webhook URL","placeholder":"e.g., https://your-domain.com/webhook"}}]},"background_audio":{"label":"Enable Background Audio","type":"boolean","component":"checkBox","default":false,"description":"Play ambient background audio during the conversation.","value":false,"formFields":[{"component":"input","model":"office_noise_url","value":null,"props":{"label":"Background Audio URL","placeholder":"e.g., https://example.com/audio.mp3"}},{"component":"input","model":"office_noise_volume","value":0.5,"props":{"label":"Background Audio Volume","placeholder":"Enter a value between 0 and 1 (e.g., 0.3)"},"type":"number","min":0,"max":1,"default":0.5}]},"call_outcome_webhook":{"label":"Enable Call Outcome Webhook","type":"boolean","component":"checkBox","default":false,"description":"Send call outcome to webhook after call ends","value":false,"formFields":[{"component":"input","model":"calloutcome_webhook_url","value":null,"props":{"label":"Call Outcome Webhook URL","placeholder":"e.g., https://your-domain.com/webhook"}}]}}},"transfer_call":{"label":"Transfer call","type":"group","description":"","children":{"find_next_folder":{"label":"Transfer calls","type":"boolean","component":"checkBox","default":false,"description":"","value":true,"assigned_route_ids":[]}}},"fine_tuning":{"label":"Speech Fine-tuning","type":"group","description":"","children":{"speed":{"label":"Speech Speed","type":"number","component":"input","default":1,"description":"Controls how fast the AI speaks.","value":1,"min":0.25,"max":1.5},"temperature":{"label":"Response Creativity","type":"number","component":"input","default":0.8,"description":"Controls response randomness.","value":0.7,"min":0,"max":2},"no_barge_seconds":{"label":"No Barge Seconds","type":"number","component":"input","default":null,"description":"Prevents callers from interrupting the greeting.","value":2,"min":0,"max":60},"drop_on_silence":{"label":"Drop Call on Silence","type":"boolean","component":"checkBox","default":false,"description":"End calls after extended caller silence.","value":true},"silence_prompt_ms":{"label":"Silence Prompt (ms)","type":"number","component":"input","default":null,"description":"Silence before asking whether the caller is still there.","value":1000,"conditional":{"field":"drop_on_silence","value":true},"min":0,"max":30000},"silence_drop_ms":{"label":"Silence Drop (ms)","type":"number","component":"input","default":null,"description":"Maximum silence before ending a call.","value":null,"conditional":{"field":"drop_on_silence","value":true},"min":0,"max":60000},"vad_method":{"label":"Voice Activity Detection Method","type":"string","component":"select","default":"server_vad","description":"Audio segmentation method.","value":"server_vad","options":[{"label":"Server VAD (silence-based)","value":"server_vad"},{"label":"Semantic VAD (content-based)","value":"semantic_vad"}]},"vad_prefix_padding_ms":{"label":"Voice Detection Prefix Padding (ms)","type":"number","component":"input","default":300,"description":"Audio kept before detected speech starts.","value":300,"conditional":{"field":"vad_method","value":"server_vad"},"min":0,"max":5000},"vad_silence_duration_ms":{"label":"Silence Duration Before Stop (ms)","type":"number","component":"input","default":700,"description":"Silence before speech is considered complete.","value":500,"conditional":{"field":"vad_method","value":"server_vad"},"min":100,"max":10000},"vad_threshold":{"label":"Voice Activity Detection Threshold","type":"number","component":"input","default":0.7,"description":"Sensitivity for detecting speech against background noise.","value":0.1,"conditional":{"field":"vad_method","value":"server_vad"},"min":0,"max":1},"vad_eagerness":{"label":"VAD Eagerness","type":"number","component":"input","default":0.6,"description":"How eager semantic VAD is to stop listening.","value":0.1,"conditional":{"field":"vad_method","value":"semantic_vad"},"min":0,"max":1},"avanser_bnum_in_instr":{"label":"Inject tracking number into AI instructions","type":"boolean","component":"checkBox","default":false,"description":"Inserts the tracking number into AI instructions.","value":false}}}}}},"id":"paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/200/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/400/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"PUT","path":"/aiagents/{agent_id}/advanced-settings","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Bad Request","code":400},"errors":{"route_id":"unsupported route type"}},"id":"paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/400/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/401/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/500/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/502/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"AI Agent service error","code":502},"errors":{"description":"The AI Agent service returned an error","code":"ai_agent_service_error"}},"id":"paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/502/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/503/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"AI Agent service is not configured","code":503},"errors":{"description":"The AI Agent service is not configured for this account","code":"ai_agent_service_not_configured"}},"id":"paths/~1aiagents~1{agent_id}~1advanced-settings/put/responses/503/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/200/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":"1234","request":{"api-version":"v1","method":"GET","path":"/v1/aiagents/120/assigned-numbers","time":"2026-10-07T20:46:29+11:00","ms":"2.814"}},"response":[{"service_number":"61267110101","name":"Example Campaign","custom_id":null,"custom_group":null,"number_type":"GEO","country":"AU","campaign_start":"2026-10-07","answer_point":{"route_id":"342650","name":"Example Agent","action":"xfr","type":"Transfer","target":"+AIA-AIAGENTID120"},"@links":{"service_uri":"/services/61267110101"}}]},"id":"paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/200/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/400/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents/{agent_id}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Bad Request","code":400},"errors":{"agent_id":"invalid"}},"id":"paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/400/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/401/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/404/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents/{agent_id}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Not Found","code":404},"errors":{"agent_id":"agent not found"}},"id":"paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/404/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/500/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/502/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"AI Agent service error","code":502},"errors":{"description":"The AI Agent service returned an error","code":"ai_agent_service_error"}},"id":"paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/502/content/application~1json/example"},"paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/503/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/aiagents","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"AI Agent service is not configured","code":503},"errors":{"description":"The AI Agent service is not configured for this account","code":"ai_agent_service_not_configured"}},"id":"paths/~1aiagents~1{agent_id}~1assigned-numbers/get/responses/503/content/application~1json/example"},"paths/~1transferroutes/get/responses/200/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":"1234","request":{"api-version":"v1","method":"GET","path":"/v1/transferroutes","time":"2026-10-07T20:46:29+11:00","ms":"0.837"}},"response":[{"id":"131219","name":"Example transfer route","action":"xfr","type":"Transfer","assignable":true,"ai_tags":[],"assigned_agent_ids":[]},{"id":"148196","name":"Example DONA route","action":"don","type":"DONA","assignable":true,"ai_tags":[],"assigned_agent_ids":[]}]},"id":"paths/~1transferroutes/get/responses/200/content/application~1json/example"},"paths/~1transferroutes/get/responses/400/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/transferroutes","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Bad Request","code":400},"errors":{"account-id":"user has no CONF/ADMIN rights the selected account"}},"id":"paths/~1transferroutes/get/responses/400/content/application~1json/example"},"paths/~1transferroutes/get/responses/401/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unauthorized","code":401},"errors":{"description":"Authentication credentials were not accepted","code":"unauthorized"}},"id":"paths/~1transferroutes/get/responses/401/content/application~1json/example"},"paths/~1transferroutes/get/responses/404/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/transferroutes","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Not Found","code":404},"errors":{"description":"Transfer routes were not found","code":"transfer_routes_not_found"}},"id":"paths/~1transferroutes/get/responses/404/content/application~1json/example"},"paths/~1transferroutes/get/responses/500/content/application~1json/example":{"value":{"@transaction":{"id":"c9220015e2f48bc7cf4b38186a7b2025","account-id":1234,"request":{"api-version":"v1","method":"GET","path":"/{resource}/?{parameters}","time":"2016-09-06T16:13:38+10:00","ms":0.039}},"error":{"message":"Unexpected Error","code":500},"errors":{"description":"An unexpected server error occurred","code":"unexpected_error"}},"id":"paths/~1transferroutes/get/responses/500/content/application~1json/example"}},"securitySchemeStore":{"HTTP_BASIC":{"id":"HTTP_BASIC","type":"http","scheme":"basic","description":"Contact AVANSER Support to obtain your credentials."}},"specVersion":"3.1.0","servers":[{"url":"https://tapi.avanser.com/v1/","description":"Avanser Production"},{"url":"/_mock/telco-api/references","isMockServer":true,"description":"AVANSER Mock Server"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/telco-api/references","position":"last","description":"AVANSER Mock Server","strictExamples":true,"errorIfForcedExampleNotFound":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/telco-api/references.json?download"},{"url":"/_bundle/telco-api/references.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"AVANSER Telco API","description":"AVANSER Telco API is designed to provide an easy way to order and manage client services.\n\nAVANSER Telco API is Agency friendly. Users can be configured to have access to multiple AVANSER accounts, facilitating service automation.\n"}},"baseSlug":"/telco-api/references","routesMapping":{}}