{"items":[{"type":"link","label":"Home","link":"/","routeSlug":"/"},{"type":"group","label":"Telco API","items":[{"type":"group","label":"Introduction","items":[{"type":"link","label":"Introduction","link":"/telco-api/introduction","routeSlug":"/telco-api/introduction"},{"type":"link","label":"Authentication","link":"/telco-api/introduction/section/authentication","routeSlug":"/telco-api/introduction/section/authentication"},{"type":"link","label":"API Model","link":"/telco-api/introduction/section/api-model","routeSlug":"/telco-api/introduction/section/api-model"},{"type":"link","label":"Synchronous Model","link":"/telco-api/introduction/section/synchronous-model","routeSlug":"/telco-api/introduction/section/synchronous-model"},{"type":"link","label":"Asynchronous Model","link":"/telco-api/introduction/section/asynchronous-model","routeSlug":"/telco-api/introduction/section/asynchronous-model"},{"type":"link","label":"Call Tags","link":"/telco-api/introduction/section/call-tags","routeSlug":"/telco-api/introduction/section/call-tags"},{"type":"link","label":"Callback-URI functionality","link":"/telco-api/introduction/section/callback-uri-functionality","routeSlug":"/telco-api/introduction/section/callback-uri-functionality"},{"type":"link","label":"Request completed","link":"/telco-api/introduction/section/request-completed","routeSlug":"/telco-api/introduction/section/request-completed"},{"type":"link","label":"Request failed","link":"/telco-api/introduction/section/request-failed","routeSlug":"/telco-api/introduction/section/request-failed"},{"type":"link","label":"Call-URI functionality","link":"/telco-api/introduction/section/call-uri-functionality","routeSlug":"/telco-api/introduction/section/call-uri-functionality"},{"type":"link","label":"SMS-Forward functionality","link":"/telco-api/introduction/section/sms-forward-functionality","routeSlug":"/telco-api/introduction/section/sms-forward-functionality"},{"type":"group","label":"AI Agents","link":"/telco-api/introduction/ai-agents","routeSlug":"/telco-api/introduction/ai-agents","items":[{"type":"link","label":"Assigned Tracking Numbers","link":"/telco-api/introduction/ai-agents/assigned-tracking-numbers","routeSlug":"/telco-api/introduction/ai-agents/assigned-tracking-numbers"},{"type":"link","label":"Country-specific answer points","link":"/telco-api/introduction/ai-agents/country-specific-answer-points","routeSlug":"/telco-api/introduction/ai-agents/country-specific-answer-points"},{"type":"link","label":"Required Agent Details","link":"/telco-api/introduction/ai-agents/required-agent-details","routeSlug":"/telco-api/introduction/ai-agents/required-agent-details"},{"type":"link","label":"Instructions","link":"/telco-api/introduction/ai-agents/instructions","routeSlug":"/telco-api/introduction/ai-agents/instructions"},{"type":"link","label":"Agent Options","link":"/telco-api/introduction/ai-agents/agent-options","routeSlug":"/telco-api/introduction/ai-agents/agent-options"},{"type":"link","label":"voice","link":"/telco-api/introduction/ai-agents/voice","routeSlug":"/telco-api/introduction/ai-agents/voice"},{"type":"link","label":"agent_role","link":"/telco-api/introduction/ai-agents/agent_role","routeSlug":"/telco-api/introduction/ai-agents/agent_role"},{"type":"link","label":"business_type","link":"/telco-api/introduction/ai-agents/business_type","routeSlug":"/telco-api/introduction/ai-agents/business_type"},{"type":"link","label":"greeting","link":"/telco-api/introduction/ai-agents/greeting","routeSlug":"/telco-api/introduction/ai-agents/greeting"},{"type":"link","label":"Example: create a new AI Agent","link":"/telco-api/introduction/ai-agents/example:-create-a-new-ai-agent","routeSlug":"/telco-api/introduction/ai-agents/example:-create-a-new-ai-agent"},{"type":"link","label":"Advanced Settings","link":"/telco-api/introduction/ai-agents/advanced-settings","routeSlug":"/telco-api/introduction/ai-agents/advanced-settings"},{"type":"link","label":"Update replaces the whole set","link":"/telco-api/introduction/ai-agents/update-replaces-the-whole-set","routeSlug":"/telco-api/introduction/ai-agents/update-replaces-the-whole-set"},{"type":"link","label":"Tools","link":"/telco-api/introduction/ai-agents/tools","routeSlug":"/telco-api/introduction/ai-agents/tools"},{"type":"link","label":"Speech Fine-tuning","link":"/telco-api/introduction/ai-agents/speech-fine-tuning","routeSlug":"/telco-api/introduction/ai-agents/speech-fine-tuning"},{"type":"link","label":"Transfer Call Routes","link":"/telco-api/introduction/ai-agents/transfer-call-routes","routeSlug":"/telco-api/introduction/ai-agents/transfer-call-routes"},{"type":"link","label":"Transfer Routes","link":"/telco-api/introduction/ai-agents/transfer-routes","routeSlug":"/telco-api/introduction/ai-agents/transfer-routes"},{"type":"link","label":"Assignable routes","link":"/telco-api/introduction/ai-agents/assignable-routes","routeSlug":"/telco-api/introduction/ai-agents/assignable-routes"},{"type":"link","label":"Tags and current assignments","link":"/telco-api/introduction/ai-agents/tags-and-current-assignments","routeSlug":"/telco-api/introduction/ai-agents/tags-and-current-assignments"},{"type":"link","label":"List AI Agents","link":"/telco-api/introduction/ai-agents/list-ai-agents","routeSlug":"/telco-api/introduction/ai-agents/list-ai-agents"},{"type":"link","label":"Create AI Agent","link":"/telco-api/introduction/ai-agents/create-ai-agent","routeSlug":"/telco-api/introduction/ai-agents/create-ai-agent"},{"type":"link","label":"List Agent Options","link":"/telco-api/introduction/ai-agents/list-agent-options","routeSlug":"/telco-api/introduction/ai-agents/list-agent-options"},{"type":"link","label":"Preview AI Agent Instructions","link":"/telco-api/introduction/ai-agents/preview-ai-agent-instructions","routeSlug":"/telco-api/introduction/ai-agents/preview-ai-agent-instructions"},{"type":"link","label":"Get AI Agent Details","link":"/telco-api/introduction/ai-agents/get-ai-agent-details","routeSlug":"/telco-api/introduction/ai-agents/get-ai-agent-details"},{"type":"link","label":"Update AI Agent","link":"/telco-api/introduction/ai-agents/update-ai-agent","routeSlug":"/telco-api/introduction/ai-agents/update-ai-agent"},{"type":"link","label":"Delete AI Agent","link":"/telco-api/introduction/ai-agents/delete-ai-agent","routeSlug":"/telco-api/introduction/ai-agents/delete-ai-agent"},{"type":"link","label":"Get AI Agent Advanced Settings","link":"/telco-api/introduction/ai-agents/get-ai-agent-advanced-settings","routeSlug":"/telco-api/introduction/ai-agents/get-ai-agent-advanced-settings"},{"type":"link","label":"Update AI Agent Advanced Settings","link":"/telco-api/introduction/ai-agents/update-ai-agent-advanced-settings","routeSlug":"/telco-api/introduction/ai-agents/update-ai-agent-advanced-settings"},{"type":"link","label":"List AI Agent Assigned Numbers","link":"/telco-api/introduction/ai-agents/list-ai-agent-assigned-numbers","routeSlug":"/telco-api/introduction/ai-agents/list-ai-agent-assigned-numbers"},{"type":"link","label":"List Transfer Routes","link":"/telco-api/introduction/ai-agents/list-transfer-routes","routeSlug":"/telco-api/introduction/ai-agents/list-transfer-routes"},{"type":"link","label":"Assignable routes","link":"/telco-api/introduction/ai-agents/assignable-routes","routeSlug":"/telco-api/introduction/ai-agents/assignable-routes"},{"type":"link","label":"Tags and current assignments","link":"/telco-api/introduction/ai-agents/tags-and-current-assignments","routeSlug":"/telco-api/introduction/ai-agents/tags-and-current-assignments"}]}]},{"type":"group","label":"API References","items":[{"type":"link","label":"API reference","link":"/telco-api/references","routeSlug":"/telco-api/references"},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/accounts/features"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/numbers?szu={szu}"}]},{"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."}},"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."}},"httpPath":"/requests"}]},{"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"}},"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"}},"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"}},"httpPath":"/requests/{request_id}/callback_body"}]},{"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"}},"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."}},"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."}},"httpPath":"/services/{service_number}/"}]},{"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"}},"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"}},"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"}},"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"}},"httpPath":"/templates?name={name}&country={country}"}]},{"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"}},"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."}},"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"}},"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."}},"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"}},"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."}},"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"}},"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"}},"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"}},"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"}},"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"}},"httpPath":"/transferroutes"}]}]}],"expanded":"true"},{"type":"group","label":"User API","items":[{"type":"group","label":"Introduction","items":[{"type":"link","label":"Introduction","link":"/user-api/introduction","routeSlug":"/user-api/introduction"},{"type":"link","label":"API Responses","link":"/user-api/introduction/section/api-responses","routeSlug":"/user-api/introduction/section/api-responses"},{"type":"link","label":"Errors","link":"/user-api/introduction/section/errors","routeSlug":"/user-api/introduction/section/errors"},{"type":"link","label":"Phone Number Formats","link":"/user-api/introduction/section/phone-number-formats","routeSlug":"/user-api/introduction/section/phone-number-formats"}]},{"type":"group","label":"API References","items":[{"type":"link","label":"API reference","link":"/user-api/references","routeSlug":"/user-api/references"},{"type":"group","label":"Authentication","link":"/user-api/references/authentication","routeSlug":"/user-api/references/authentication","items":[{"label":"Login","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user-api/references/authentication/login","routeSlug":"/user-api/references/authentication/login","metadata":{"seo":{"title":"Login","description":"Request an access token to use in API calls. The access token is returned as a string in the data key."}},"httpPath":"/login"},{"label":"Logout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user-api/references/authentication/logout","routeSlug":"/user-api/references/authentication/logout","metadata":{"seo":{"title":"Logout","description":"Remove the user's API token."}},"httpPath":"/logout"},{"label":"Forgot Password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user-api/references/authentication/forgotpassword","routeSlug":"/user-api/references/authentication/forgotpassword","metadata":{"seo":{"title":"Forgot Password","description":"Request to change the user's password. An email will be sent to the user containing a verification code."}},"httpPath":"/forgotpassword"},{"label":"Reset Password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user-api/references/authentication/resetpassword","routeSlug":"/user-api/references/authentication/resetpassword","metadata":{"seo":{"title":"Reset Password","description":"Change the user's password using the verification code sent to the user's email address."}},"httpPath":"/resetpassword"},{"label":"Set Registration Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user-api/references/authentication/setregistrationtoken","routeSlug":"/user-api/references/authentication/setregistrationtoken","metadata":{"seo":{"title":"Set Registration Token","description":"Set Registration Token for the device."}},"httpPath":"/setregistrationtoken"}]},{"type":"group","label":"Calls","link":"/user-api/references/calls","routeSlug":"/user-api/references/calls","items":[{"label":"Call Log","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user-api/references/calls/calllog","routeSlug":"/user-api/references/calls/calllog","metadata":{"seo":{"title":"Call Log","description":"Retrieve a list of call records for the current day."}},"httpPath":"/calls"},{"label":"Make Call","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user-api/references/calls/makecall","routeSlug":"/user-api/references/calls/makecall","metadata":{"seo":{"title":"Make Call","description":"Initiate an outgoing phone call that will be tracked by the AVANSER call tracking service. The process is as follows:"}},"httpPath":"/dial"}]},{"type":"group","label":"SMS","link":"/user-api/references/sms","routeSlug":"/user-api/references/sms","items":[{"label":"List Messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user-api/references/sms/listmessages","routeSlug":"/user-api/references/sms/listmessages","metadata":{"seo":{"title":"List Messages","description":"Retrieve a list of SMS messages for the logged in user."}},"httpPath":"/messages"},{"label":"Send Message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user-api/references/sms/sendmessage","routeSlug":"/user-api/references/sms/sendmessage","metadata":{"seo":{"title":"Send Message","description":"Send an SMS message. The bnum needs to be an AVANSER BNUM that the logged in user has access to send messages from. For more information about checking this, see the Mobile BNUMs section in the User Information documentation"}},"httpPath":"/sendmessage"},{"label":"Message delivery status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user-api/references/sms/messagedeliverystatus","routeSlug":"/user-api/references/sms/messagedeliverystatus","metadata":{"seo":{"title":"Message delivery status","description":"Retrieve the delivery status for a specific SMS using its Message ID. The Message ID is provided in the Send Message API response as the third parameter in the data string."}},"httpPath":"/deliverystatus"}]},{"type":"group","label":"User Information","link":"/user-api/references/user-information","routeSlug":"/user-api/references/user-information","items":[{"label":"Get User Information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user-api/references/user-information/getuserinformation","routeSlug":"/user-api/references/user-information/getuserinformation","metadata":{"seo":{"title":"Get User Information","description":"Retrieve profile information about the currently logged in user. The return result in the example has been condensed to include only the data that an application may be interested in."}},"httpPath":"/profile"}]},{"type":"group","label":"Validate Phone Numbers","link":"/user-api/references/validate-phone-numbers","routeSlug":"/user-api/references/validate-phone-numbers","items":[{"label":"Validate Phone Number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user-api/references/validate-phone-numbers/validatephonenumber","routeSlug":"/user-api/references/validate-phone-numbers/validatephonenumber","metadata":{"seo":{"title":"Validate Phone Number","description":"Checks that the phone number provided is in a valid format within the country for the dial prefix provided. Note that this doesn't actually check that the phone number exists, just that it is in a valid format. If the error key returns false, it means that the phone number is valid."}},"httpPath":"/checknumber"}]},{"type":"group","label":"Data Caching","link":"/user-api/references/data-caching","routeSlug":"/user-api/references/data-caching","items":[{"label":"Disable Cache Flags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user-api/references/data-caching/disablecacheflags","routeSlug":"/user-api/references/data-caching/disablecacheflags","metadata":{"seo":{"title":"Disable Cache Flags","description":"When an application discards locally cached data as a result of receiving a flush_calls or flush_messages flag in an API result, it should call this method to inform the API to stop returning the corresponding flag in future API results."}},"httpPath":"/options"}]}]}],"expanded":"true"},{"type":"group","label":"Web API","items":[{"type":"group","label":"Introduction","items":[{"type":"link","label":"Introduction","link":"/web-api/introduction","routeSlug":"/web-api/introduction"},{"type":"link","label":"Disclaimer","link":"/web-api/introduction/section/disclaimer","routeSlug":"/web-api/introduction/section/disclaimer"},{"type":"link","label":"General Information About the API","link":"/web-api/introduction/section/general-information-about-the-api","routeSlug":"/web-api/introduction/section/general-information-about-the-api"},{"type":"link","label":"Glossary","link":"/web-api/introduction/section/glossary","routeSlug":"/web-api/introduction/section/glossary"},{"type":"link","label":"Call Completion Codes","link":"/web-api/introduction/section/call-completion-codes","routeSlug":"/web-api/introduction/section/call-completion-codes"}]},{"type":"group","label":"API References","items":[{"type":"link","label":"API reference","link":"/web-api/references","routeSlug":"/web-api/references"},{"type":"group","label":"Authentication","link":"/web-api/references/authentication","routeSlug":"/web-api/references/authentication","items":[{"type":"link","label":"HTTP Basic Authentication","link":"/web-api/references/authentication/http-basic-authentication","routeSlug":"/web-api/references/authentication/http-basic-authentication"},{"type":"link","label":"Token-Based Authentication","link":"/web-api/references/authentication/token-based-authentication","routeSlug":"/web-api/references/authentication/token-based-authentication"},{"label":"Phase 1 - Request a Token Key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/web-api/references/authentication/requesttokenkey","routeSlug":"/web-api/references/authentication/requesttokenkey","metadata":{"seo":{"title":"Phase 1 - Request a Token Key","description":"Returns the token key that is required in Phase 2."}},"httpPath":"/JSON?action=getTokenKey"},{"label":"Phase 2 - Sign in and Request a Session Token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/web-api/references/authentication/requestsessiontoken","routeSlug":"/web-api/references/authentication/requestsessiontoken","metadata":{"seo":{"title":"Phase 2 - Sign in and Request a Session Token","description":"Returns a session token to use in other API calls. The signature parameter is an MD5 hash of: Your secret key, and the token key retrieved in Phase 1."}},"httpPath":"/JSON?action=signIn"}]},{"type":"group","label":"Request Data","link":"/web-api/references/request-data","routeSlug":"/web-api/references/request-data","items":[{"label":"Request CDR","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/web-api/references/request-data/requestcdr","routeSlug":"/web-api/references/request-data/requestcdr","metadata":{"seo":{"title":"Request CDR","description":"Retrieve a list of call detail records."}},"httpPath":"/JSON?action=getCDR"},{"label":"Download Audio File","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/web-api/references/request-data/downloadaudiofile","routeSlug":"/web-api/references/request-data/downloadaudiofile","metadata":{"seo":{"title":"Download Audio File","description":"Download the audio file associated with a call, formatted as an mp3. If there is no recording associated with a call, the response code will be 404."}},"httpPath":"/JSON?action=getAudio"},{"label":"Obtain Extra Referrer Data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/web-api/references/request-data/obtainextrareferrerdata","routeSlug":"/web-api/references/request-data/obtainextrareferrerdata","metadata":{"seo":{"title":"Obtain Extra Referrer Data","description":"If you have an AVANSER C2C (Click-to-Connect) button, this call requests information on the button click."}},"httpPath":"/JSON?action=getC2C"},{"label":"Get Call Evaluation Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/web-api/references/request-data/getcallevaluationdetails","routeSlug":"/web-api/references/request-data/getcallevaluationdetails","metadata":{"seo":{"title":"Get Call Evaluation Details","description":"If you are using Call Evaluation, this call returns information on the list of questions that make up the evaluation, in the order that they are presented to the evaluating user."}},"httpPath":"/JSON?action=evaluationDetails"},{"label":"Get Call Analysis","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/web-api/references/request-data/getcallanalysis","routeSlug":"/web-api/references/request-data/getcallanalysis","metadata":{"seo":{"title":"Get Call Analysis","description":"This call returns information about a single call record, including transcription details if it is enabled."}},"httpPath":"/JSON?action=callAnalysis"}]}]}],"expanded":"true"}]}