{"items":[{"type":"link","label":"Numbers | Sinch","link":"/docs/numbers/api-reference/numbers","routeSlug":"/docs/numbers/api-reference/numbers","content":{"contentType":"overview","meta":{"name":"Numbers | Sinch"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"numbers.json","url":"/_bundle/docs/numbers/api-reference/numbers.json?download"},{"kind":"download","label":"numbers.yaml","url":"/_bundle/docs/numbers/api-reference/numbers.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://www.sinch.com","url":"https://www.sinch.com"},{"kind":"email","title":"Support","email":"Support@sinch.com","label":"Support@sinch.com","withCopyButton":true,"copyContent":"Support@sinch.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"MIT","url":"https://www.sinch.com/toc"}]},{"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://numbers.api.sinch.com","description":"Global API"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Numbers | Sinch (1.0.3)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/docs/numbers/api-reference/numbers"}],"sectionId":"/docs/numbers/api-reference/numbers"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/overview"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Numbers API enables you to search for, buy, view, and manage numbers. It's considered a precursor to other APIs in the Sinch product family. The numbers API can be used in tandem with any of our APIs that perform messaging or calling. Once you have bought your numbers, you can then use the various other APIs, such as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/sms/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/voice/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Voice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", to assign and use those numbers."},"children":[]}]}]}]}],"sectionId":"/docs/numbers/api-reference/numbers/section/overview"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/overview/choosing-how-to-buy-a-number"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Choosing how to buy a number"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/numbers/number-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API to buy numbers. It supports numbers from all regions and of all number types, and it collects any registration (KYC) information and supporting documents a region requires:"},"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":"Check what the region and number type require (\"Lookup number requirements\")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Find a number to buy (\"Search for available phone numbers\" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/numbers/available-number"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available Numbers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API), or skip this step and order by criteria instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create the order, provide any required registration information and documents, and submit it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a step-by-step walkthrough, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/kyc-numbers-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ordering numbers that meet specific requirements"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The Available Numbers activation endpoints, \"Activate a new phone number\" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableNumbers/{phoneNumber}:rent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and \"Rent any number that matches the criteria\" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableNumbers:rentAny"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), are deprecated and only support US "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" numbers. They remain available for existing integrations, but new integrations should use the Number Order API. The Available Numbers search endpoints aren't deprecated and work for all regions and number types."},"children":[]}]}]}]}],"sectionId":"/docs/numbers/api-reference/numbers/section/overview/choosing-how-to-buy-a-number"}],"sectionId":"/docs/numbers/api-reference/numbers/section/overview/choosing-how-to-buy-a-number"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/overview/numbers-rest-formats-and-conventions"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numbers REST formats and conventions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Let's take a brief look at some of the formats used in the REST API."},"children":[]}]}]}]}],"sectionId":"/docs/numbers/api-reference/numbers/section/overview/numbers-rest-formats-and-conventions"}],"sectionId":"/docs/numbers/api-reference/numbers/section/overview/numbers-rest-formats-and-conventions"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/overview/json"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is the content type of both requests and responses if not otherwise specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests with invalid JSON will be rejected."},"children":[]}]}]}]}],"sectionId":"/docs/numbers/api-reference/numbers/section/overview/json"}],"sectionId":"/docs/numbers/api-reference/numbers/section/overview/json"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/overview/null-values"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Null values"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Null values can be omitted in requests and will be omitted in responses. In some cases, explicitly setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will overwrite a previously set value with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/docs/numbers/api-reference/numbers/section/overview/null-values"}],"sectionId":"/docs/numbers/api-reference/numbers/section/overview/null-values"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/overview/phone-numbers"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone numbers"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only phone numbers in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://community.sinch.com/t5/Glossary/E-164/ta-p/7537"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" standard format are accepted by the API."},"children":[]}]}]}]}],"sectionId":"/docs/numbers/api-reference/numbers/section/overview/phone-numbers"}],"sectionId":"/docs/numbers/api-reference/numbers/section/overview/phone-numbers"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"section/overview/examples:"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"US phone number:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+13059394139"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UK phone number:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+447478727259"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SE phone number:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+46113232516"},"children":[]}]}]}]}]}],"sectionId":"/docs/numbers/api-reference/numbers/section/overview/examples:"}],"sectionId":"/docs/numbers/api-reference/numbers/section/overview/examples:"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/overview/status-codes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status codes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A summary of status codes can be found on the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/error-codes/status-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP status codes page"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/docs/numbers/api-reference/numbers/section/overview/status-codes"}],"sectionId":"/docs/numbers/api-reference/numbers/section/overview/status-codes"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/overview/ip-addresses-for-callbacks"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IP addresses for callbacks"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To successfully use callbacks with Numbers, add the following IP addresses to your allowlist:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"54.76.19.159"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"54.78.194.39"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"54.155.83.128"},"children":[]}]}]}]}]}],"sectionId":"/docs/numbers/api-reference/numbers/section/overview/ip-addresses-for-callbacks"}],"sectionId":"/docs/numbers/api-reference/numbers/section/overview/ip-addresses-for-callbacks"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/overview/new-features"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New features"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New features might result in additional request and response parameters. New request parameters will either have a default value or be considered optional to retain backwards compatibility. It's highly recommended to ignore any unexpected parameters when reading JSON in API responses and in callback handlers."},"children":[]}]}]}]}],"sectionId":"/docs/numbers/api-reference/numbers/section/overview/new-features"}],"sectionId":"/docs/numbers/api-reference/numbers/section/overview/new-features"}]}]}},{"type":"group","label":"Overview","link":"/docs/numbers/api-reference/numbers/section/overview","routeSlug":"/docs/numbers/api-reference/numbers/section/overview","items":[{"type":"link","label":"Choosing how to buy a number","link":"/docs/numbers/api-reference/numbers/section/overview/choosing-how-to-buy-a-number","routeSlug":"/docs/numbers/api-reference/numbers/section/overview/choosing-how-to-buy-a-number","content":null},{"type":"link","label":"Numbers REST formats and conventions","link":"/docs/numbers/api-reference/numbers/section/overview/numbers-rest-formats-and-conventions","routeSlug":"/docs/numbers/api-reference/numbers/section/overview/numbers-rest-formats-and-conventions","content":null},{"type":"link","label":"JSON","link":"/docs/numbers/api-reference/numbers/section/overview/json","routeSlug":"/docs/numbers/api-reference/numbers/section/overview/json","content":null},{"type":"link","label":"Null values","link":"/docs/numbers/api-reference/numbers/section/overview/null-values","routeSlug":"/docs/numbers/api-reference/numbers/section/overview/null-values","content":null},{"type":"link","label":"Phone numbers","link":"/docs/numbers/api-reference/numbers/section/overview/phone-numbers","routeSlug":"/docs/numbers/api-reference/numbers/section/overview/phone-numbers","content":null},{"type":"link","label":"Examples:","link":"/docs/numbers/api-reference/numbers/section/overview/examples:","routeSlug":"/docs/numbers/api-reference/numbers/section/overview/examples:","content":null},{"type":"link","label":"Status codes","link":"/docs/numbers/api-reference/numbers/section/overview/status-codes","routeSlug":"/docs/numbers/api-reference/numbers/section/overview/status-codes","content":null},{"type":"link","label":"IP addresses for callbacks","link":"/docs/numbers/api-reference/numbers/section/overview/ip-addresses-for-callbacks","routeSlug":"/docs/numbers/api-reference/numbers/section/overview/ip-addresses-for-callbacks","content":null},{"type":"link","label":"New features","link":"/docs/numbers/api-reference/numbers/section/overview/new-features","routeSlug":"/docs/numbers/api-reference/numbers/section/overview/new-features","content":null}],"content":null},{"type":"group","label":"Available Numbers","link":"/docs/numbers/api-reference/numbers/available-number","routeSlug":"/docs/numbers/api-reference/numbers/available-number","items":[{"label":"Search for available phone numbers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/available-number/numberservice_listavailablenumbers","routeSlug":"/docs/numbers/api-reference/numbers/available-number/numberservice_listavailablenumbers","metadata":{"seo":{"title":"Search for available phone numbers","description":"Search for available phone numbers that are available for you to activate. You can filter by any property on the available number resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"NumberService_ListAvailableNumbers","name":"Search for available phone numbers","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1availableNumbers/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for available phone numbers","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 phone numbers that are available for you to activate. You can filter by any property on the available number resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When searching, indicate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the number in the array as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SMS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VOICE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". To search for a number capable of both, list both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SMS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VOICE"},"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":"text","inline":true,"attributes":{"content":"You can search for numbers in any region and of any number type. To buy a number from the search results, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/numbers/number-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1availableNumbers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"numberPattern.pattern","in":"query","schemaId":"schema_691","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sequence of digits to search for. If you prefer or need certain digits in sequential order, you can enter the sequence of numbers here. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2020"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"numberPattern.searchPattern","in":"query","schemaId":"schema_692","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search pattern to apply. The options are, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"START"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTAINS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"regionCode","in":"query","schemaId":"schema_693","description":"Region code to filter by. ISO 3166-1 alpha-2 country code of the phone number. Example: US, GB or SE.","required":true},{"name":"type","in":"query","schemaId":"schema_694","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number type to filter by. Options include, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MOBILE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TOLL_FREE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"capabilities","in":"query","schemaId":"schema_695","description":"Number capabilities to filter by SMS and/or VOICE."},{"name":"size","in":"query","schemaId":"schema_696","description":"Optional. The maximum number of items to return.","example":3}],"pointer":"/paths/~1v1~1projects~1{projectId}~1availableNumbers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/availableNumbers","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"}],"query":[{"name":"numberPattern.pattern","in":"query","required":false,"example":"%2B120","schemaId":"schema_691"},{"name":"numberPattern.searchPattern","in":"query","required":false,"schemaId":"components/schemas/NumberPatternSearchPattern"},{"name":"regionCode","in":"query","required":true,"example":"US","schemaId":"schema_693"},{"name":"type","in":"query","required":true,"schemaId":"components/schemas/NumberType"},{"name":"capabilities","in":"query","required":false,"schemaId":"schema_695"},{"name":"size","in":"query","required":false,"example":3,"schemaId":"schema_696"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","403","404","500"],"pointer":"/v1/projects/{projectId}/availableNumbers","href":"available-number/numberservice_listavailablenumbers","openApiOperationId":"NumberService_ListAvailableNumbers","summary":"Search for available phone numbers","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"definitionSamples":[{"lang":"Java","source":"/**\n * Sinch Java Snippet\n *\n * <p>This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n * <p>See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage numbers;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.numbers.api.v1.NumbersService;\nimport com.sinch.sdk.domains.numbers.models.v1.NumberType;\nimport com.sinch.sdk.domains.numbers.models.v1.request.AvailableNumbersListQueryParameters;\nimport com.sinch.sdk.domains.numbers.models.v1.response.AvailableNumbersListResponse;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class SearchForAvailableNumbers {\n\n  private static final Logger LOGGER = Logger.getLogger(SearchForAvailableNumbers.class.getName());\n\n  public static void main(String[] args) {\n\n    String projectId = Settings.getProjectId().orElse(\"MY_PROJECT_ID\");\n    String keyId = Settings.getKeyId().orElse(\"MY_KEY_ID\");\n    String keySecret = Settings.getKeySecret().orElse(\"MY_KEY_SECRET\");\n\n    // ISO 3166-1 alpha-2 country code of the phone number. e.g. \"US\", \"GB\", \"SE\"...\n    // See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 for details\n    String regionCode = \"MY_REGION_CODE\";\n    NumberType type = NumberType.LOCAL;\n\n    Configuration configuration =\n        Configuration.builder()\n            .setProjectId(projectId)\n            .setKeyId(keyId)\n            .setKeySecret(keySecret)\n            .build();\n\n    SinchClient client = new SinchClient(configuration);\n\n    NumbersService numbersService = client.numbers().v1();\n\n    AvailableNumbersListQueryParameters parameters =\n        AvailableNumbersListQueryParameters.builder()\n            .setRegionCode(regionCode)\n            .setType(type)\n            .build();\n\n    LOGGER.info(\"Looking for available numbers\");\n\n    AvailableNumbersListResponse response = numbersService.searchForAvailableNumbers(parameters);\n\n    response\n        .iterator()\n        .forEachRemaining(\n            number -> LOGGER.info(String.format(\"Available number details: %s\", number)));\n  }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';\n  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';\n  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';\n\n  const sinch = new SinchClient({ projectId, keyId, keySecret });\n\n  try{\n    const response = await sinch.numbers.searchForAvailableNumbers({\n      regionCode: 'US',\n      type: 'LOCAL',\n    });\n    if (!response.availableNumbers?.length) {\n      console.log('No phone numbers are available with these criteria.');\n      return;\n    }\n    console.log(`✅ Found ${response.availableNumbers.length} numbers to rent.`);\n    response.availableNumbers.forEach((number) => {\n      console.log(number);\n    });\n  } catch (err) {\n    console.error('❌ Failed to list phone numbers to rent:');\n    console.error(err);\n  }\n}\n\nmain();\n"},{"lang":"Python","source":"\"\"\"\nSinch Python Snippet\n\nThis snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets\n\"\"\"\n\nimport os\nfrom dotenv import load_dotenv\nfrom sinch import SinchClient\n\nload_dotenv()\n\nsinch_client = SinchClient(\n    project_id=os.environ.get(\"SINCH_PROJECT_ID\") or \"MY_PROJECT_ID\",\n    key_id=os.environ.get(\"SINCH_KEY_ID\") or \"MY_KEY_ID\",\n    key_secret=os.environ.get(\"SINCH_KEY_SECRET\") or \"MY_KEY_SECRET\"\n)\n\navailable_numbers = sinch_client.numbers.search_for_available_numbers(\n    region_code=\"AR\",\n    number_type=\"LOCAL\"\n)\n\nprint(\"Available numbers to rent:\\n\")\nfor number in available_numbers.iterator():\n    print(number)\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A successful response, or an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/error-codes/status-codes/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAvailableNumbersResponse"}},"schemaId":"components/schemas/ListAvailableNumbersResponse"},{"code":"400","description":"400 Invalid Argument error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}},"schemaId":"components/schemas/InvalidArgument"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERMISSION_DENIED: improper credentials. Be sure your projectId, username and password are correct."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers/get/responses/403/content/application~1json/example"]},{"code":"404","description":"404 Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1availableNumbers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListAvailableNumbersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAvailableNumbersResponse"}}},{"code":"400","schemaId":"components/schemas/InvalidArgument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}}},{"code":"403","schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/available-number/numberservice_listavailablenumbers"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/availableNumbers"},{"label":"Search for a specific phone number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/available-number/numberservice_getavailablenumber","routeSlug":"/docs/numbers/api-reference/numbers/available-number/numberservice_getavailablenumber","metadata":{"seo":{"title":"Search for a specific phone number","description":"This endpoint allows you to enter a specific phone number to check if it's available for use. A 200 response will return the number's capability, setup costs, monthly costs and if supporting documentation is required."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"NumberService_GetAvailableNumber","name":"Search for a specific phone number","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for a specific phone number","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":"This endpoint allows you to enter a specific phone number to check if it's available for use. A 200 response will return the number's capability, setup costs, monthly costs and if supporting documentation is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To buy the number, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/numbers/number-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true},{"name":"phoneNumber","in":"path","schemaId":"schema_698","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output only. The phone number in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://community.sinch.com/t5/Glossary/E-164/ta-p/7537"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with leading "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/availableNumbers/{phoneNumber}","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"},{"name":"phoneNumber","in":"path","required":true,"example":"+12025550134","schemaId":"schema_698"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","403","404","500"],"pointer":"/v1/projects/{projectId}/availableNumbers/{phoneNumber}","href":"available-number/numberservice_getavailablenumber","openApiOperationId":"NumberService_GetAvailableNumber","summary":"Search for a specific phone number","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"definitionSamples":[{"lang":"Java","source":"/**\n * Sinch Java Snippet\n *\n * <p>This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n * <p>See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage numbers;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.numbers.api.v1.NumbersService;\nimport com.sinch.sdk.domains.numbers.models.v1.response.AvailableNumber;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class CheckAvailability {\n\n  private static final Logger LOGGER = Logger.getLogger(CheckAvailability.class.getName());\n\n  public static void main(String[] args) {\n\n    String projectId = Settings.getProjectId().orElse(\"MY_PROJECT_ID\");\n    String keyId = Settings.getKeyId().orElse(\"MY_KEY_ID\");\n    String keySecret = Settings.getKeySecret().orElse(\"MY_KEY_SECRET\");\n\n    String phoneNumber = \"A_PHONE_NUMBER_TO_CHECK\";\n\n    Configuration configuration =\n        Configuration.builder()\n            .setProjectId(projectId)\n            .setKeyId(keyId)\n            .setKeySecret(keySecret)\n            .build();\n\n    SinchClient client = new SinchClient(configuration);\n\n    NumbersService numbersService = client.numbers().v1();\n\n    LOGGER.info(\"CheckAvailability for: \" + phoneNumber);\n\n    AvailableNumber value = numbersService.checkAvailability(phoneNumber);\n\n    LOGGER.info(\"Response: \" + value);\n  }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';\n  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';\n  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';\n\n  // The phone number to check for rental availability\n  const phoneNumber = 'PHONE_NUMBER';\n\n  const sinch = new SinchClient({ projectId, keyId, keySecret });\n\n  try{\n    const response = await sinch.numbers.checkAvailability({ phoneNumber });\n    console.log('✅ Phone number is available to rent.');\n    console.log(JSON.stringify(response, null, 2));\n  } catch (err) {\n    console.error(`❌ Failed to get a successful status for the phone number's availability (${phoneNumber}):`);\n    console.error(err);\n  }\n}\n\nmain();\n"},{"lang":"Python","source":"\"\"\"\nSinch Python Snippet\n\nThis snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets\n\"\"\"\n\nimport os\nfrom dotenv import load_dotenv\nfrom sinch import SinchClient\n\nload_dotenv()\n\nsinch_client = SinchClient(\n    project_id=os.environ.get(\"SINCH_PROJECT_ID\") or \"MY_PROJECT_ID\",\n    key_id=os.environ.get(\"SINCH_KEY_ID\") or \"MY_KEY_ID\",\n    key_secret=os.environ.get(\"SINCH_KEY_SECRET\") or \"MY_KEY_SECRET\"\n)\n\n# The phone number to check in E.164 format\nphone_number = \"PHONE_NUMBER\"\n\nresponse = sinch_client.numbers.check_availability(\n    phone_number=phone_number\n)\n\nprint(\"The phone number is available:\\n\", response)\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A successful response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AvailableNumber"}},"schemaId":"components/schemas/AvailableNumber"},{"code":"400","description":"400 Invalid Argument error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}},"schemaId":"components/schemas/InvalidArgument"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERMISSION_DENIED: improper credentials. Be sure your projectId, username and password are correct."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"404 Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AvailableNumber","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AvailableNumber"}}},{"code":"400","schemaId":"components/schemas/InvalidArgument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}}},{"code":"403","schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/available-number/numberservice_getavailablenumber"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/availableNumbers/{phoneNumber}"},{"label":"Activate a new phone number","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/available-number/numberservice_rentnumber","routeSlug":"/docs/numbers/api-reference/numbers/available-number/numberservice_rentnumber","metadata":{"seo":{"title":"Activate a new phone number","description":"Deprecated: This endpoint is deprecated. It remains available for existing integrations, but new integrations should use the Number Order API, which supports numbers from all regions and of all number types. To order a specific number with a number order, use numberOrderOption in the \"Create a number order\" endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"NumberService_RentNumber","name":"Activate a new phone number","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate a new phone number","isWebhook":false,"deprecated":true,"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint is deprecated. It remains available for existing integrations, but new integrations should use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/numbers/number-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API, which supports numbers from all regions and of all number types. To order a specific number with a number order, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberOrderOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the \"Create a number order\" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activate a phone number to use with SMS products, Voice products, or both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint only supports US "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" numbers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You'll use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smsConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to setup your number for SMS and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Voice. To setup for both, add both objects. See the dropdown menu (just under language selection) for code samples."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: You cannot add both objects if you only need to configure one object. For example, if you only need to configure "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smsConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for SMS messaging, do not add the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object or it will result in an error."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true},{"name":"phoneNumber","in":"path","schemaId":"schema_698","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output only. The phone number in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://community.sinch.com/t5/Glossary/E-164/ta-p/7537"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with leading "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RentNumberRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateFaxNumber"]}},"schemaId":"components/schemas/RentNumberRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateFaxNumber"],"pointer":"/paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody","description":"The request to rent a number."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/availableNumbers/{phoneNumber}:rent","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"},{"name":"phoneNumber","in":"path","required":true,"example":"+12025550134","schemaId":"schema_698"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RentNumberRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateFaxNumber"]}},"responseCodes":["200","400","403","404","500"],"pointer":"/v1/projects/{projectId}/availableNumbers/{phoneNumber}:rent","href":"available-number/numberservice_rentnumber","openApiOperationId":"NumberService_RentNumber","summary":"Activate a new phone number","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"definitionSamples":[{"lang":"Java","source":"/**\n * Sinch Java Snippet\n *\n * <p>This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n * <p>See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage numbers;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.numbers.api.v1.NumbersService;\nimport com.sinch.sdk.domains.numbers.models.v1.ActiveNumber;\nimport com.sinch.sdk.domains.numbers.models.v1.SmsConfiguration;\nimport com.sinch.sdk.domains.numbers.models.v1.request.AvailableNumberRentRequest;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class Rent {\n\n  private static final Logger LOGGER = Logger.getLogger(Rent.class.getName());\n\n  public static void main(String[] args) {\n\n    String projectId = Settings.getProjectId().orElse(\"MY_PROJECT_ID\");\n    String keyId = Settings.getKeyId().orElse(\"MY_KEY_ID\");\n    String keySecret = Settings.getKeySecret().orElse(\"MY_KEY_SECRET\");\n\n    String servicePlanIdToAssociateWithTheNumber =\n        Settings.getServicePlanId().orElse(\"MY_SERVICE_PLAN_ID\");\n\n    // Available numbers list can be retrieved by using list() function from available service, see\n    // the SearchAvailableSnippet or\n    // https://developers.sinch.com/docs/numbers/getting-started/java-sdk/searchavailable\n    String phoneNumberToBeRented = \"AVAILABLE_PHONE_NUMBER_TO_BE_RENTED\";\n\n    Configuration configuration =\n        Configuration.builder()\n            .setProjectId(projectId)\n            .setKeyId(keyId)\n            .setKeySecret(keySecret)\n            .build();\n\n    SinchClient client = new SinchClient(configuration);\n\n    NumbersService numbersService = client.numbers().v1();\n\n    SmsConfiguration smsConfiguration =\n        SmsConfiguration.builder().setServicePlanId(servicePlanIdToAssociateWithTheNumber).build();\n\n    AvailableNumberRentRequest parameters =\n        AvailableNumberRentRequest.builder().setSmsConfiguration(smsConfiguration).build();\n\n    ActiveNumber response = numbersService.rent(phoneNumberToBeRented, parameters);\n\n    LOGGER.info(String.format(\"Rented number: %s\", response));\n  }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';\n  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';\n  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';\n\n  // The available phone number to rent\n  const phoneNumber = 'PHONE_NUMBER';\n  // The service plan ID to associate with the phone number\n  const servicePlanId = process.env.SINCH_SERVICE_PLAN_ID ?? 'MY_SERVICE_PLAN_ID';\n\n  const sinch = new SinchClient({ projectId, keyId, keySecret });\n\n  try{\n    const response = await sinch.numbers.rent({\n      phoneNumber: phoneNumber,\n      rentNumberRequestBody: {\n        smsConfiguration: {\n          servicePlanId,\n        },\n      },\n    });\n    console.log('✅ Successfully rented the phone number.');\n    console.log(JSON.stringify(response, null, 2));\n  } catch (err) {\n    console.error(`❌ Failed to rent the phone number ${phoneNumber}:`);\n    console.error(err);\n  }\n}\n\nmain();\n"},{"lang":"Python","source":"\"\"\"\nSinch Python Snippet\n\nThis snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets\n\"\"\"\n\nimport os\nfrom dotenv import load_dotenv\nfrom sinch import SinchClient\nfrom sinch.domains.numbers.models.v1.types import SmsConfigurationDict\n\nload_dotenv()\n\nsinch_client = SinchClient(\n    project_id=os.environ.get(\"SINCH_PROJECT_ID\") or \"MY_PROJECT_ID\",\n    key_id=os.environ.get(\"SINCH_KEY_ID\") or \"MY_KEY_ID\",\n    key_secret=os.environ.get(\"SINCH_KEY_SECRET\") or \"MY_KEY_SECRET\"\n)\n\n# The available phone number to rent in E.164 format\nphone_number = \"PHONE_NUMBER\"\n# The service plan ID to associate with the phone number\nservice_plan_id = os.environ.get(\"SINCH_SERVICE_PLAN_ID\") or \"MY_SERVICE_PLAN_ID\"\nsms_configuration: SmsConfigurationDict = {\n    \"service_plan_id\": service_plan_id,\n}\n\nrented_number = sinch_client.numbers.rent(\n    phone_number=phone_number,\n    sms_configuration=sms_configuration\n)\nprint(\"Rented Number:\\n\", rented_number)\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"schemaId":"components/schemas/RentNumberRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateFaxNumber"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RentNumberRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateFaxNumber"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A successful response, or an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/error-codes/status-codes/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActiveNumberResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateFaxNumber"]}},"schemaId":"components/schemas/ActiveNumberResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateFaxNumber"]},{"code":"400","description":"400 Invalid Argument error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}},"schemaId":"components/schemas/InvalidArgument"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERMISSION_DENIED: improper credentials. Be sure your projectId, username and password are correct."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/403/content/application~1json/example"]},{"code":"404","description":"404 Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActiveNumberResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateFaxNumber"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActiveNumberResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateFaxNumber"]}}},{"code":"400","schemaId":"components/schemas/InvalidArgument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}}},{"code":"403","schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/available-number/numberservice_rentnumber"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/availableNumbers/{phoneNumber}:rent"},{"label":"Rent any number that matches the criteria","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/available-number/numberservice_rentanynumber","routeSlug":"/docs/numbers/api-reference/numbers/available-number/numberservice_rentanynumber","metadata":{"seo":{"title":"Rent any number that matches the criteria","description":"Deprecated: This endpoint is deprecated. It remains available for existing integrations, but new integrations should use the Number Order API, which supports numbers from all regions and of all number types. To order numbers that match a set of criteria with a number order, use quantityOrderOption in the \"Create a number order\" endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"NumberService_RentAnyNumber","name":"Rent any number that matches the criteria","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1availableNumbers:rentAny/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rent any number that matches the criteria","isWebhook":false,"deprecated":true,"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint is deprecated. It remains available for existing integrations, but new integrations should use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/numbers/number-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API, which supports numbers from all regions and of all number types. To order numbers that match a set of criteria with a number order, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantityOrderOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the \"Create a number order\" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activates the first available phone number that matches the search criteria provided in the request. You can't review the specific number before it's activated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint only supports US "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" numbers, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regionCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1availableNumbers:rentAny/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RentAnyNumberRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers:rentAny/post/requestBody/content/application~1json/examples/activateSMSNumber"]}},"schemaId":"components/schemas/RentAnyNumberRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers:rentAny/post/requestBody/content/application~1json/examples/activateSMSNumber"],"pointer":"/paths/~1v1~1projects~1{projectId}~1availableNumbers:rentAny/post/requestBody","description":"The request to search and rent a number that matches the criteria."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/availableNumbers:rentAny","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RentAnyNumberRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers:rentAny/post/requestBody/content/application~1json/examples/activateSMSNumber"]}},"responseCodes":["200","400","403","404","500"],"pointer":"/v1/projects/{projectId}/availableNumbers:rentAny","href":"available-number/numberservice_rentanynumber","openApiOperationId":"NumberService_RentAnyNumber","summary":"Rent any number that matches the criteria","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"definitionSamples":[{"lang":"Java","source":"/**\n * Sinch Java Snippet\n *\n * <p>This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n * <p>See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage numbers;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.numbers.api.v1.NumbersService;\nimport com.sinch.sdk.domains.numbers.models.v1.ActiveNumber;\nimport com.sinch.sdk.domains.numbers.models.v1.NumberType;\nimport com.sinch.sdk.domains.numbers.models.v1.SmsConfiguration;\nimport com.sinch.sdk.domains.numbers.models.v1.request.AvailableNumberRentAnyRequest;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class RentAny {\n\n  private static final Logger LOGGER = Logger.getLogger(RentAny.class.getName());\n\n  public static void main(String[] args) {\n\n    String projectId = Settings.getProjectId().orElse(\"MY_PROJECT_ID\");\n    String keyId = Settings.getKeyId().orElse(\"MY_KEY_ID\");\n    String keySecret = Settings.getKeySecret().orElse(\"MY_KEY_SECRET\");\n\n    String servicePlanIdToAssociateWithTheNumber =\n        Settings.getServicePlanId().orElse(\"MY_SERVICE_PLAN_ID\");\n\n    // ISO 3166-1 alpha-2 country code of the phone number. e.g. \"US\", \"GB\", \"SE\"...\n    // See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 for details\n    String regionCode = \"MY_REGION_CODE\";\n\n    NumberType numberType = NumberType.LOCAL;\n\n    Configuration configuration =\n        Configuration.builder()\n            .setProjectId(projectId)\n            .setKeyId(keyId)\n            .setKeySecret(keySecret)\n            .build();\n\n    SinchClient client = new SinchClient(configuration);\n\n    NumbersService numbersService = client.numbers().v1();\n\n    SmsConfiguration smsConfiguration =\n        SmsConfiguration.builder().setServicePlanId(servicePlanIdToAssociateWithTheNumber).build();\n\n    AvailableNumberRentAnyRequest parameters =\n        AvailableNumberRentAnyRequest.builder()\n            .setType(numberType)\n            .setRegionCode(regionCode)\n            .setSmsConfiguration(smsConfiguration)\n            .build();\n\n    ActiveNumber response = numbersService.rentAny(parameters);\n\n    LOGGER.info(String.format(\"Rented number: %s\", response));\n  }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';\n  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';\n  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';\n\n  // The service plan ID to associate with the phone number\n  const servicePlanId = process.env.SINCH_SERVICE_PLAN_ID ?? 'MY_SERVICE_PLAN_ID';\n\n  const sinch = new SinchClient({ projectId, keyId, keySecret });\n\n  try{\n    const response = await sinch.numbers.rentAny({\n      rentAnyNumberRequestBody: {\n        regionCode: 'US',\n        type: 'LOCAL',\n        smsConfiguration: {\n          servicePlanId,\n        },\n      },\n    });\n    console.log('✅ Successfully rented a phone number.');\n    console.log(JSON.stringify(response, null, 2));\n  } catch (err) {\n    console.error('❌ Failed to rent a phone number:');\n    console.error(err);\n  }\n}\n\nmain();\n"},{"lang":"Python","source":"\"\"\"\nSinch Python Snippet\n\nThis snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets\n\"\"\"\n\nimport os\nfrom dotenv import load_dotenv\nfrom sinch import SinchClient\nfrom sinch.domains.numbers.models.v1.types import SmsConfigurationDict\n\nload_dotenv()\n\nsinch_client = SinchClient(\n    project_id=os.environ.get(\"SINCH_PROJECT_ID\") or \"MY_PROJECT_ID\",\n    key_id=os.environ.get(\"SINCH_KEY_ID\") or \"MY_KEY_ID\",\n    key_secret=os.environ.get(\"SINCH_KEY_SECRET\") or \"MY_KEY_SECRET\"\n)\n\n# The service plan ID to associate with the phone number\nservice_plan_id = os.environ.get(\"SINCH_SERVICE_PLAN_ID\") or \"MY_SERVICE_PLAN_ID\"\nsms_configuration: SmsConfigurationDict = {\n    \"service_plan_id\": service_plan_id,\n}\n# The URL to receive the notifications about provisioning events\nevent_destination_target = \"CALLBACK_URL\"\n\nresponse = sinch_client.numbers.rent_any(\n    region_code=\"US\",\n    number_type=\"LOCAL\",\n    capabilities=[\"SMS\", \"VOICE\"],\n    sms_configuration=sms_configuration,\n    event_destination_target=event_destination_target\n)\n\nprint(\"Rented Number:\\n\", response)\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"schemaId":"components/schemas/RentAnyNumberRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers:rentAny/post/requestBody/content/application~1json/examples/activateSMSNumber"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RentAnyNumberRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers:rentAny/post/requestBody/content/application~1json/examples/activateSMSNumber"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A successful response, or an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/error-codes/status-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActiveNumberResponse"}},"schemaId":"components/schemas/ActiveNumberResponse","headers":{}},{"code":"400","description":"400 Invalid Argument error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}},"schemaId":"components/schemas/InvalidArgument"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERMISSION_DENIED: improper credentials. Be sure your projectId, username and password are correct."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers:rentAny/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers:rentAny/post/responses/403/content/application~1json/example"]},{"code":"404","description":"404 Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1availableNumbers:rentAny/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActiveNumberResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActiveNumberResponse"}}},{"code":"400","schemaId":"components/schemas/InvalidArgument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}}},{"code":"403","schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers:rentAny/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableNumbers:rentAny/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/available-number/numberservice_rentanynumber"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/availableNumbers:rentAny"}],"content":{"contentType":"group","meta":{"name":"Available Number"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Available Numbers","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use the Available Number API to search for numbers that are available to buy, in any region and of any number type, and to check a specific number's availability, price, and capabilities."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To buy a number you found, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/numbers/number-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The activation endpoints in this API, \"Activate a new phone number\" and \"Rent any number that matches the criteria\", are deprecated and only support US "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" numbers. They remain available for existing integrations, but new integrations should use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/numbers/number-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API, which supports numbers from all regions and of all number types."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/availableNumbers","summary":"Search for available phone numbers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/available-number/numberservice_listavailablenumbers","deprecated":false},{"title":"/v1/projects/{projectId}/availableNumbers/{phoneNumber}","summary":"Search for a specific phone number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/available-number/numberservice_getavailablenumber","deprecated":false},{"title":"/v1/projects/{projectId}/availableNumbers/{phoneNumber}:rent","summary":"Activate a new phone number","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/available-number/numberservice_rentnumber","deprecated":true},{"title":"/v1/projects/{projectId}/availableNumbers:rentAny","summary":"Rent any number that matches the criteria","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/available-number/numberservice_rentanynumber","deprecated":true}]}]}]}]}},{"type":"group","label":"Number Order","link":"/docs/numbers/api-reference/numbers/number-order","routeSlug":"/docs/numbers/api-reference/numbers/number-order","items":[{"label":"Lookup number requirements","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/number-order/lookupnumberrequirements","routeSlug":"/docs/numbers/api-reference/numbers/number-order/lookupnumberrequirements","metadata":{"seo":{"title":"Lookup number requirements","description":"Returns required KYC fields info based on number type & country legislation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"LookupNumberRequirements","name":"Lookup number requirements","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders:lookupNumberRequirements/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lookup number requirements","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":"Returns required KYC fields info based on number type & country legislation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can follow a detailed tutorial outlining the entire ordering process "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/kyc-numbers-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders:lookupNumberRequirements/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LookupNumberRequirementsRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders:lookupNumberRequirements/post/requestBody/content/application~1json/examples/LookupAustralianKycRequirementsRequest"]}},"schemaId":"components/schemas/LookupNumberRequirementsRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders:lookupNumberRequirements/post/requestBody/content/application~1json/examples/LookupAustralianKycRequirementsRequest"],"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders:lookupNumberRequirements/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/numberOrders:lookupNumberRequirements","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LookupNumberRequirementsRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders:lookupNumberRequirements/post/requestBody/content/application~1json/examples/LookupAustralianKycRequirementsRequest"]}},"responseCodes":["200","400","500"],"pointer":"/v1/projects/{projectId}/numberOrders:lookupNumberRequirements","href":"number-order/lookupnumberrequirements","openApiOperationId":"LookupNumberRequirements","summary":"Lookup number requirements","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"schemaId":"components/schemas/LookupNumberRequirementsRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders:lookupNumberRequirements/post/requestBody/content/application~1json/examples/LookupAustralianKycRequirementsRequest"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LookupNumberRequirementsRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders:lookupNumberRequirements/post/requestBody/content/application~1json/examples/LookupAustralianKycRequirementsRequest"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NumberRequirements","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders:lookupNumberRequirements/post/responses/200/content/application~1json/examples/LookupAustralianKycRequirementsResponse"]}},"schemaId":"components/schemas/NumberRequirements","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders:lookupNumberRequirements/post/responses/200/content/application~1json/examples/LookupAustralianKycRequirementsResponse"]},{"code":"400","description":"400 Invalid Argument error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}},"schemaId":"components/schemas/InvalidArgument"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders:lookupNumberRequirements/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NumberRequirements","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders:lookupNumberRequirements/post/responses/200/content/application~1json/examples/LookupAustralianKycRequirementsResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NumberRequirements","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders:lookupNumberRequirements/post/responses/200/content/application~1json/examples/LookupAustralianKycRequirementsResponse"]}}},{"code":"400","schemaId":"components/schemas/InvalidArgument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/number-order/lookupnumberrequirements"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/numberOrders:lookupNumberRequirements"},{"label":"Create a number order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/number-order/createnumberorder","routeSlug":"/docs/numbers/api-reference/numbers/number-order/createnumberorder","metadata":{"seo":{"title":"Create a number order","description":"Create a number order for a specific number or for a quantity of numbers matching a set of criteria (pattern, capabilities etc.) - reserves the phone numbers for a period between 30 minutes and 48 hours (check the expireTime field) and creates entities for collecting KYC info."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateNumberOrder","name":"Create a number order","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a number order","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":"Create a number order for a specific number or for a quantity of numbers matching a set of criteria (pattern, capabilities etc.) - reserves the phone numbers for a period between 30 minutes and 48 hours (check the expireTime field) and creates entities for collecting KYC info."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set exactly one of these options:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberOrderOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": order specific phone numbers. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phoneNumbers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must contain exactly one phone number; ordering more than one number per order isn't currently supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantityOrderOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": order between 1 and 100 numbers ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requestedQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that match the given criteria."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can follow a detailed tutorial outlining the entire ordering process "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/kyc-numbers-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateNumberOrderRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/requestBody/content/application~1json/examples/CreateAustralianNumberOrderRequest","paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/requestBody/content/application~1json/examples/CreateUsQuantityOrderRequest"]}},"schemaId":"components/schemas/CreateNumberOrderRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/requestBody/content/application~1json/examples/CreateAustralianNumberOrderRequest","paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/requestBody/content/application~1json/examples/CreateUsQuantityOrderRequest"],"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/numberOrders:createNumberOrder","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateNumberOrderRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/requestBody/content/application~1json/examples/CreateAustralianNumberOrderRequest","paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/requestBody/content/application~1json/examples/CreateUsQuantityOrderRequest"]}},"responseCodes":["200","400","500"],"pointer":"/v1/projects/{projectId}/numberOrders:createNumberOrder","href":"number-order/createnumberorder","openApiOperationId":"CreateNumberOrder","summary":"Create a number order","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"schemaId":"components/schemas/CreateNumberOrderRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/requestBody/content/application~1json/examples/CreateAustralianNumberOrderRequest","paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/requestBody/content/application~1json/examples/CreateUsQuantityOrderRequest"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateNumberOrderRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/requestBody/content/application~1json/examples/CreateAustralianNumberOrderRequest","paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/requestBody/content/application~1json/examples/CreateUsQuantityOrderRequest"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NumberOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/responses/200/content/application~1json/examples/AustralianNumberOrder"]}},"schemaId":"components/schemas/NumberOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/responses/200/content/application~1json/examples/AustralianNumberOrder"]},{"code":"400","description":"400 Invalid Argument error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}},"schemaId":"components/schemas/InvalidArgument"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NumberOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/responses/200/content/application~1json/examples/AustralianNumberOrder"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NumberOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/responses/200/content/application~1json/examples/AustralianNumberOrder"]}}},{"code":"400","schemaId":"components/schemas/InvalidArgument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/number-order/createnumberorder"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/numberOrders:createNumberOrder"},{"label":"Get a number order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/number-order/getnumberorder","routeSlug":"/docs/numbers/api-reference/numbers/number-order/getnumberorder","metadata":{"seo":{"title":"Get a number order","description":"Returns the number order alongside all reserved numbers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetNumberOrder","name":"Get a number order","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a number order","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":"Returns the number order alongside all reserved numbers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can follow a detailed tutorial outlining the entire ordering process "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/kyc-numbers-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true},{"name":"numberOrderId","in":"path","schemaId":"schema_699","description":"The ID of the number order created by the REST API user.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/numberOrders/{numberOrderId}","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"},{"name":"numberOrderId","in":"path","required":true,"schemaId":"schema_699"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/v1/projects/{projectId}/numberOrders/{numberOrderId}","href":"number-order/getnumberorder","openApiOperationId":"GetNumberOrder","summary":"Get a number order","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NumberOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}/get/responses/200/content/application~1json/examples/AustralianNumberOrder"]}},"schemaId":"components/schemas/NumberOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}/get/responses/200/content/application~1json/examples/AustralianNumberOrder"]},{"code":"404","description":"404 Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NumberOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}/get/responses/200/content/application~1json/examples/AustralianNumberOrder"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NumberOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}/get/responses/200/content/application~1json/examples/AustralianNumberOrder"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/number-order/getnumberorder"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/numberOrders/{numberOrderId}"},{"label":"Update number order registration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/number-order/updatenumberorderregistration","routeSlug":"/docs/numbers/api-reference/numbers/number-order/updatenumberorderregistration","metadata":{"seo":{"title":"Update number order registration","description":"Updates the registration (vehicle for KYC info) for a specific number order. Validated against the country requirements revealed by the \"Lookup number requirements\" endpoints."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateNumberOrderRegistration","name":"Update number order registration","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update number order registration","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":"Updates the registration (vehicle for KYC info) for a specific number order. Validated against the country requirements revealed by the \"Lookup number requirements\" endpoints."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can follow a detailed tutorial outlining the entire ordering process "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/kyc-numbers-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true},{"name":"numberOrderId","in":"path","schemaId":"schema_699","description":"The ID of the number order created by the REST API user.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateNumberOrderRegistrationRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/put/requestBody/content/application~1json/examples/updateAustralianRegistration"]}},"schemaId":"components/schemas/UpdateNumberOrderRegistrationRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/put/requestBody/content/application~1json/examples/updateAustralianRegistration"],"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/projects/{projectId}/numberOrders/{numberOrderId}/registration","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"},{"name":"numberOrderId","in":"path","required":true,"schemaId":"schema_699"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateNumberOrderRegistrationRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/put/requestBody/content/application~1json/examples/updateAustralianRegistration"]}},"responseCodes":["200","400","404","500"],"pointer":"/v1/projects/{projectId}/numberOrders/{numberOrderId}/registration","href":"number-order/updatenumberorderregistration","openApiOperationId":"UpdateNumberOrderRegistration","summary":"Update number order registration","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"schemaId":"components/schemas/UpdateNumberOrderRegistrationRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/put/requestBody/content/application~1json/examples/updateAustralianRegistration"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateNumberOrderRegistrationRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/put/requestBody/content/application~1json/examples/updateAustralianRegistration"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Registration","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/put/responses/200/content/application~1json/examples/australianRegistration"]}},"schemaId":"components/schemas/Registration","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/put/responses/200/content/application~1json/examples/australianRegistration"]},{"code":"400","description":"400 Invalid Argument error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}},"schemaId":"components/schemas/InvalidArgument"},{"code":"404","description":"404 Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Registration","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/put/responses/200/content/application~1json/examples/australianRegistration"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Registration","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/put/responses/200/content/application~1json/examples/australianRegistration"]}}},{"code":"400","schemaId":"components/schemas/InvalidArgument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/number-order/updatenumberorderregistration"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/numberOrders/{numberOrderId}/registration"},{"label":"Get number order registration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/number-order/getnumberorderregistration","routeSlug":"/docs/numbers/api-reference/numbers/number-order/getnumberorderregistration","metadata":{"seo":{"title":"Get number order registration","description":"Retrieves the Registration submitted for a number order via the \"Update number order registration\" endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetNumberOrderRegistration","name":"Get number order registration","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get number order registration","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":"Retrieves the Registration submitted for a number order via the \"Update number order registration\" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can follow a detailed tutorial outlining the entire ordering process "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/kyc-numbers-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true},{"name":"numberOrderId","in":"path","schemaId":"schema_699","description":"The ID of the number order created by the REST API user.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/numberOrders/{numberOrderId}/registration","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"},{"name":"numberOrderId","in":"path","required":true,"schemaId":"schema_699"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/v1/projects/{projectId}/numberOrders/{numberOrderId}/registration","href":"number-order/getnumberorderregistration","openApiOperationId":"GetNumberOrderRegistration","summary":"Get number order registration","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Registration","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/get/responses/200/content/application~1json/examples/australianRegistration"]}},"schemaId":"components/schemas/Registration","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/get/responses/200/content/application~1json/examples/australianRegistration"]},{"code":"404","description":"404 Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Registration","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/get/responses/200/content/application~1json/examples/australianRegistration"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Registration","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/get/responses/200/content/application~1json/examples/australianRegistration"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/number-order/getnumberorderregistration"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/numberOrders/{numberOrderId}/registration"},{"label":"Upload an attachment for a number order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/number-order/uploadnumberorderattachment","routeSlug":"/docs/numbers/api-reference/numbers/number-order/uploadnumberorderattachment","metadata":{"seo":{"title":"Upload an attachment for a number order","description":"Upload file attachments to a number order registration. Mandatory only if revealed in the requirements returned by the \"Lookup number requirements\" endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UploadNumberOrderAttachment","name":"Upload an attachment for a number order","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1attachments~1{attachmentId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload an attachment for a number order","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":"Upload file attachments to a number order registration. Mandatory only if revealed in the requirements returned by the \"Lookup number requirements\" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"attachmentId\" URL parameter is the one returned by the \"Lookup number requirements\" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can follow a detailed tutorial outlining the entire ordering process "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/kyc-numbers-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true},{"name":"numberOrderId","in":"path","schemaId":"schema_699","description":"The ID of the number order created by the REST API user.","required":true},{"name":"attachmentId","in":"path","schemaId":"schema_700","description":"attachment IDs are returned by the \"Lookup number requirements\" endpoint","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1attachments~1{attachmentId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_701"}},"schemaId":"schema_701","pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1attachments~1{attachmentId}/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File attachment upload request body with Content-Type = multipart/form-data"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/numberOrders/{numberOrderId}/attachments/{attachmentId}","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"},{"name":"numberOrderId","in":"path","required":true,"schemaId":"schema_699"},{"name":"attachmentId","in":"path","required":true,"example":"d1c7ccbf-919d-462f-8587-dec95a1b11zz","schemaId":"schema_700"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_701"}},"responseCodes":["200","400","404","413","500"],"pointer":"/v1/projects/{projectId}/numberOrders/{numberOrderId}/attachments/{attachmentId}","href":"number-order/uploadnumberorderattachment","openApiOperationId":"UploadNumberOrderAttachment","summary":"Upload an attachment for a number order","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"schemaId":"schema_701","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_701"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Document uploaded successfully"},{"code":"400","description":"400 Invalid Argument error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}},"schemaId":"components/schemas/InvalidArgument"},{"code":"404","description":"404 Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"413","description":"Document is too large to upload","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RequestEntityTooLarge"}},"schemaId":"components/schemas/RequestEntityTooLarge"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1attachments~1{attachmentId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/InvalidArgument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"413","schemaId":"components/schemas/RequestEntityTooLarge","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RequestEntityTooLarge"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/number-order/uploadnumberorderattachment"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/numberOrders/{numberOrderId}/attachments/{attachmentId}"},{"label":"Submit number order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/number-order/submitnumberorder","routeSlug":"/docs/numbers/api-reference/numbers/number-order/submitnumberorder","metadata":{"seo":{"title":"Submit number order","description":"Submits the order for review, assuming the KYC info and attachments were submitted using their dedicated endpoints."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SubmitNumberOrder","name":"Submit number order","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1submit/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit number order","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":"Submits the order for review, assuming the KYC info and attachments were submitted using their dedicated endpoints."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can follow a detailed tutorial outlining the entire ordering process "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/kyc-numbers-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true},{"name":"numberOrderId","in":"path","schemaId":"schema_699","description":"The ID of the number order created by the REST API user.","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1submit/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/numberOrders/{numberOrderId}/submit","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"},{"name":"numberOrderId","in":"path","required":true,"schemaId":"schema_699"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/v1/projects/{projectId}/numberOrders/{numberOrderId}/submit","href":"number-order/submitnumberorder","openApiOperationId":"SubmitNumberOrder","summary":"Submit number order","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NumberOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1submit/post/responses/200/content/application~1json/examples/AustralianNumberOrder"]}},"schemaId":"components/schemas/NumberOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1submit/post/responses/200/content/application~1json/examples/AustralianNumberOrder"]},{"code":"404","description":"404 Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1submit/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NumberOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1submit/post/responses/200/content/application~1json/examples/AustralianNumberOrder"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NumberOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1submit/post/responses/200/content/application~1json/examples/AustralianNumberOrder"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/number-order/submitnumberorder"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/numberOrders/{numberOrderId}/submit"}],"content":{"contentType":"group","meta":{"name":"Number Order"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Number Order","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use the Number Order API to buy numbers. This is the recommended way to buy numbers: it supports numbers from all regions and of all number types, including numbers that require registration (KYC) information and supporting documents."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number order reserves the numbers, lets you provide the information the region requires, and is then submitted for review. The numbers aren't activated immediately: track the order's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the \"Get a number order\" endpoint or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NUMBER_ORDER_PROCESSING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" callbacks."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create an order in one of two ways:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order specific phone numbers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberOrderOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): order a phone number you found with \"Search for available phone numbers\". Only one phone number per order is currently supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order by quantity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantityOrderOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): order between 1 and 100 numbers that match your criteria (pattern, capabilities), without choosing the specific numbers."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Steps for buying a number via an order and providing the required KYC information:"},"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":"\"Lookup number requirements\" endpoint: look up country KYC requirements to establish which fields / information needs to be provided as part of buying the phone number. Also reveals if any attachment files need to be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Search for available phone numbers\" endpoint (in the Available Numbers API): search numbers you may want to buy. Not needed if you order by quantity."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Create a number order\" endpoint: create the Number Order for a specific phone number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberOrderOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or for a quantity of numbers matching a set of criteria ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantityOrderOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), which reserves the numbers for a period between 30 minutes and 48 hours (check the expireTime field), giving plenty of time to call the other endpoint to submit the fields required as revealed by the API at 1. and also to hit the final Submit endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Update number order registration\" endpoint: update the order Registration (container for the actual KYC required fields / information revealed at step #1). This is validated on the spot for required / optional fields, fields lengths etc. (also revealed at step #1)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Upload an attachment for a number order\" endpoint: upload file attachments - only if mandatory as per requirements revealed by step #1. AttachmentId necessary for the URL will be returned at step #1."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Submit number order\" endpoint: submit the order - final step after creating the order and providing registration info and (if required) attachments"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can follow a detailed tutorial outlining the entire ordering process "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/kyc-numbers-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/numberOrders:lookupNumberRequirements","summary":"Lookup number requirements","prefix":{"name":"post","color":"post"},"badges":[],"link":"/number-order/lookupnumberrequirements","deprecated":false},{"title":"/v1/projects/{projectId}/numberOrders:createNumberOrder","summary":"Create a number order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/number-order/createnumberorder","deprecated":false},{"title":"/v1/projects/{projectId}/numberOrders/{numberOrderId}","summary":"Get a number order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/number-order/getnumberorder","deprecated":false},{"title":"/v1/projects/{projectId}/numberOrders/{numberOrderId}/registration","summary":"Update number order registration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/number-order/updatenumberorderregistration","deprecated":false},{"title":"/v1/projects/{projectId}/numberOrders/{numberOrderId}/registration","summary":"Get number order registration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/number-order/getnumberorderregistration","deprecated":false},{"title":"/v1/projects/{projectId}/numberOrders/{numberOrderId}/attachments/{attachmentId}","summary":"Upload an attachment for a number order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/number-order/uploadnumberorderattachment","deprecated":false},{"title":"/v1/projects/{projectId}/numberOrders/{numberOrderId}/submit","summary":"Submit number order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/number-order/submitnumberorder","deprecated":false}]}]}]}]}},{"type":"group","label":"Active Numbers","link":"/docs/numbers/api-reference/numbers/active-number","routeSlug":"/docs/numbers/api-reference/numbers/active-number","items":[{"label":"Lists active numbers for a project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/active-number/numberservice_listactivenumbers","routeSlug":"/docs/numbers/api-reference/numbers/active-number/numberservice_listactivenumbers","metadata":{"seo":{"title":"Lists active numbers for a project","description":"Lists all active numbers for a project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"NumberService_ListActiveNumbers","name":"Lists active numbers for a project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists active numbers for a project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all active numbers for a project."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"regionCode","in":"query","schemaId":"schema_693","description":"Region code to filter by. ISO 3166-1 alpha-2 country code of the phone number. Example: US, GB or SE."},{"name":"numberPattern.pattern","in":"query","schemaId":"schema_691","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sequence of digits to search for. If you prefer or need certain digits in sequential order, you can enter the sequence of numbers here. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2020"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"numberPattern.searchPattern","in":"query","schemaId":"schema_692","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search pattern to apply. The options are, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"START"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTAINS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"type","in":"query","schemaId":"schema_694","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number type to filter by. Options include, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MOBILE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TOLL_FREE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"capability","in":"query","schemaId":"schema_695","description":"Number capabilities to filter by SMS and/or VOICE."},{"name":"pageSize","in":"query","schemaId":"schema_696","description":"The maximum number of items to return."},{"name":"pageToken","in":"query","schemaId":"schema_699","description":"The next page token value returned from a previous List request, if any."},{"name":"orderBy","in":"query","schemaId":"schema_702","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported fields for ordering by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phoneNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"displayName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/activeNumbers","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"}],"query":[{"name":"regionCode","in":"query","required":false,"example":"US","schemaId":"schema_693"},{"name":"numberPattern.pattern","in":"query","required":false,"example":"%2B120","schemaId":"schema_691"},{"name":"numberPattern.searchPattern","in":"query","required":false,"schemaId":"components/schemas/NumberPatternSearchPattern"},{"name":"type","in":"query","required":false,"schemaId":"components/schemas/NumberType"},{"name":"capability","in":"query","required":false,"schemaId":"schema_695"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_696"},{"name":"pageToken","in":"query","required":false,"schemaId":"schema_699"},{"name":"orderBy","in":"query","required":false,"schemaId":"schema_702"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","403","404","500"],"pointer":"/v1/projects/{projectId}/activeNumbers","href":"active-number/numberservice_listactivenumbers","openApiOperationId":"NumberService_ListActiveNumbers","summary":"Lists active numbers for a project","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"definitionSamples":[{"lang":"Java","source":"/**\n * Sinch Java Snippet\n *\n * <p>This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n * <p>See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage numbers;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.numbers.api.v1.NumbersService;\nimport com.sinch.sdk.domains.numbers.models.v1.response.ActiveNumbersListResponse;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class List {\n\n  private static final Logger LOGGER = Logger.getLogger(List.class.getName());\n\n  public static void main(String[] args) {\n\n    String projectId = Settings.getProjectId().orElse(\"MY_PROJECT_ID\");\n    String keyId = Settings.getKeyId().orElse(\"MY_KEY_ID\");\n    String keySecret = Settings.getKeySecret().orElse(\"MY_KEY_SECRET\");\n\n    Configuration configuration =\n        Configuration.builder()\n            .setProjectId(projectId)\n            .setKeyId(keyId)\n            .setKeySecret(keySecret)\n            .build();\n\n    SinchClient client = new SinchClient(configuration);\n\n    NumbersService numbersService = client.numbers().v1();\n\n    LOGGER.info(\"Listing active numbers\");\n\n    ActiveNumbersListResponse response = numbersService.list();\n\n    LOGGER.info(\"Response\");\n\n    response\n        .iterator()\n        .forEachRemaining(f -> LOGGER.info(String.format(\"%s: %s\", f.getPhoneNumber(), f)));\n  }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';\n  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';\n  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';\n\n  const sinch = new SinchClient({ projectId, keyId, keySecret });\n\n  try {\n    const response = await sinch.numbers.list({\n      regionCode: 'US',\n      type: 'LOCAL',\n    });\n    if (response.data.length === 0) {\n      console.log('No rented phone numbers found.');\n      return;\n    }\n    console.log(`✅ Found ${response.data.length} rented phone numbers.`);\n    response.data.forEach((phoneNumber) => {\n      console.log(phoneNumber);\n    });\n  } catch (err) {\n    console.error('❌ Failed to list the rented phone numbers:');\n    console.error(err);\n  }\n}\n\nmain();\n"},{"lang":"Python","source":"\"\"\"\nSinch Python Snippet\n\nThis snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets\n\"\"\"\n\nimport os\nfrom dotenv import load_dotenv\nfrom sinch import SinchClient\n\nload_dotenv()\n\nsinch_client = SinchClient(\n    project_id=os.environ.get(\"SINCH_PROJECT_ID\") or \"MY_PROJECT_ID\",\n    key_id=os.environ.get(\"SINCH_KEY_ID\") or \"MY_KEY_ID\",\n    key_secret=os.environ.get(\"SINCH_KEY_SECRET\") or \"MY_KEY_SECRET\"\n)\n\nactive_numbers = sinch_client.numbers.list(\n    region_code=\"US\",\n    number_type=\"LOCAL\"\n)\n\npage_counter = 1\nwhile True:\n    print(f\"Page {page_counter} List of Numbers: {active_numbers}\")\n\n    if not active_numbers.has_next_page:\n        break\n\n    active_numbers = active_numbers.next_page()\n    page_counter += 1\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A successful response, or an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/error-codes/status-codes/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListActiveNumbersResponse"}},"schemaId":"components/schemas/ListActiveNumbersResponse"},{"code":"400","description":"400 Invalid Argument error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}},"schemaId":"components/schemas/InvalidArgument"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERMISSION_DENIED: improper credentials. Be sure your projectId, username and password are correct."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers/get/responses/403/content/application~1json/example"]},{"code":"404","description":"404 Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListActiveNumbersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListActiveNumbersResponse"}}},{"code":"400","schemaId":"components/schemas/InvalidArgument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}}},{"code":"403","schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/active-number/numberservice_listactivenumbers"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/activeNumbers"},{"label":"Update an active phone number","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/active-number/numberservice_updateactivenumber","routeSlug":"/docs/numbers/api-reference/numbers/active-number/numberservice_updateactivenumber","metadata":{"seo":{"title":"Update an active phone number","description":"Update an active phone number. You can perform the following updates:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"NumberService_UpdateActiveNumber","name":"Update an active phone number","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an active phone number","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":"Update an active phone number. You can perform the following updates:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the name that displays for a customer by modifying the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"displayName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlink the number from an SMS service or campaign by updating the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smsConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" configuration object. To unlink a number, submit the request with an empty string ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"””"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in the service plan ID or campaign ID fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before linking a number to a new service or campaign, it must be unlinked from any existing service or campaign. Then, link the number to a new SMS service or campaign by updating the service plan ID or campaign ID with the new desired value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the Voice app to which the number is assigned by using the voiceConfiguration object."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can update both SMS and Voice in the same object by including both configuration objects. If you only need to update either Voice or SMS, simply omit the other object. If you pass an empty configuration object, the request will fail."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true},{"name":"phoneNumber","in":"path","schemaId":"schema_698","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output only. The phone number in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://community.sinch.com/t5/Glossary/E-164/ta-p/7537"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with leading "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActiveNumberRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateSMSNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateVoiceNumber"]}},"schemaId":"components/schemas/ActiveNumberRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateSMSNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateVoiceNumber"],"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody","description":"The number body to be updated."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"},{"name":"phoneNumber","in":"path","required":true,"example":"+12025550134","schemaId":"schema_698"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ActiveNumberRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateSMSNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateVoiceNumber"]}},"responseCodes":["200","400","403","404","500"],"pointer":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}","href":"active-number/numberservice_updateactivenumber","openApiOperationId":"NumberService_UpdateActiveNumber","summary":"Update an active phone number","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"definitionSamples":[{"lang":"Java","source":"/**\n * Sinch Java Snippet\n *\n * <p>This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n * <p>See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage numbers;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.numbers.api.v1.NumbersService;\nimport com.sinch.sdk.domains.numbers.models.v1.ActiveNumber;\nimport com.sinch.sdk.domains.numbers.models.v1.request.ActiveNumberUpdateRequest;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class Update {\n\n  private static final Logger LOGGER = Logger.getLogger(Update.class.getName());\n\n  public static void main(String[] args) {\n\n    String projectId = Settings.getProjectId().orElse(\"MY_PROJECT_ID\");\n    String keyId = Settings.getKeyId().orElse(\"MY_KEY_ID\");\n    String keySecret = Settings.getKeySecret().orElse(\"MY_KEY_SECRET\");\n\n    String phoneNumber = Settings.getPhoneNumber().orElse(\"MY_SINCH_PHONE_NUMBER\");\n\n    String displayName = \"Updated with Sinch Java SDK\";\n\n    Configuration configuration =\n        Configuration.builder()\n            .setProjectId(projectId)\n            .setKeyId(keyId)\n            .setKeySecret(keySecret)\n            .build();\n\n    SinchClient client = new SinchClient(configuration);\n\n    NumbersService numbersService = client.numbers().v1();\n\n    ActiveNumberUpdateRequest updateRequest =\n        ActiveNumberUpdateRequest.builder().setDisplayName(displayName).build();\n\n    ActiveNumber response = numbersService.update(phoneNumber, updateRequest);\n\n    LOGGER.info(String.format(\"Updated number: %s\", response));\n  }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';\n  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';\n  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';\n\n  // The phone number to update\n  const phoneNumber = process.env.SINCH_PHONE_NUMBER ?? 'MY_SINCH_PHONE_NUMBER';\n  const updatedDisplayName = 'Updated name with Sinch Node.js SDK';\n\n  const sinch = new SinchClient({ projectId, keyId, keySecret });\n\n  try {\n    const response = await sinch.numbers.update({\n      phoneNumber,\n      updateActiveNumberRequestBody: {\n        displayName: updatedDisplayName,\n      },\n    });\n    console.log('✅ Successfully updated the phone number.');\n    console.log(JSON.stringify(response, null, 2));\n  } catch (err) {\n    console.error(`❌ Failed to update the phone number ${phoneNumber}:`);\n    console.error(err);\n  }\n}\n\nmain();\n"},{"lang":"Python","source":"\"\"\"\nSinch Python Snippet\n\nThis snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets\n\"\"\"\n\nimport os\nfrom dotenv import load_dotenv\nfrom sinch import SinchClient\n\nload_dotenv()\n\nsinch_client = SinchClient(\n    project_id=os.environ.get(\"SINCH_PROJECT_ID\") or \"MY_PROJECT_ID\",\n    key_id=os.environ.get(\"SINCH_KEY_ID\") or \"MY_KEY_ID\",\n    key_secret=os.environ.get(\"SINCH_KEY_SECRET\") or \"MY_KEY_SECRET\"\n)\n\n# The phone number to update in E.164 format\nphone_number = os.environ.get(\"SINCH_PHONE_NUMBER\") or \"MY_PHONE_NUMBER\"\n# The display name to set for the number\ndisplay_name = \"Updated DISPLAY_NAME\"\n\nresponse = sinch_client.numbers.update(\n    phone_number=phone_number,\n    display_name=display_name,\n)\n\nprint(\"Updated Number:\\n\", response)\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"schemaId":"components/schemas/ActiveNumberRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateSMSNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateVoiceNumber"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActiveNumberRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateSMSNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateVoiceNumber"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A successful response, or an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/error-codes/status-codes/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActiveNumberResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateFaxNumber"]}},"schemaId":"components/schemas/ActiveNumberResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateFaxNumber"]},{"code":"400","description":"400 Invalid Argument error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}},"schemaId":"components/schemas/InvalidArgument"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERMISSION_DENIED: improper credentials. Be sure your projectId, username and password are correct."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/403/content/application~1json/example"]}},"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"404 Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActiveNumberResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateFaxNumber"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActiveNumberResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateFaxNumber"]}}},{"code":"400","schemaId":"components/schemas/InvalidArgument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}}},{"code":"403","schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/active-number/numberservice_updateactivenumber"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}"},{"label":"Retrieve an active phone number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/active-number/numberservice_getactivenumber","routeSlug":"/docs/numbers/api-reference/numbers/active-number/numberservice_getactivenumber","metadata":{"seo":{"title":"Retrieve an active phone number","description":"Retrieve a specific active phone number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"NumberService_GetActiveNumber","name":"Retrieve an active phone number","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an active phone number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific active phone number."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true},{"name":"phoneNumber","in":"path","schemaId":"schema_698","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output only. The phone number in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://community.sinch.com/t5/Glossary/E-164/ta-p/7537"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with leading "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"},{"name":"phoneNumber","in":"path","required":true,"example":"+12025550134","schemaId":"schema_698"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}","href":"active-number/numberservice_getactivenumber","openApiOperationId":"NumberService_GetActiveNumber","summary":"Retrieve an active phone number","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"definitionSamples":[{"lang":"Java","source":"/**\n * Sinch Java Snippet\n *\n * <p>This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n * <p>See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage numbers;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.numbers.api.v1.NumbersService;\nimport com.sinch.sdk.domains.numbers.models.v1.ActiveNumber;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class Get {\n\n  private static final Logger LOGGER = Logger.getLogger(Get.class.getName());\n\n  public static void main(String[] args) {\n\n    String projectId = Settings.getProjectId().orElse(\"MY_PROJECT_ID\");\n    String keyId = Settings.getKeyId().orElse(\"MY_KEY_ID\");\n    String keySecret = Settings.getKeySecret().orElse(\"MY_KEY_SECRET\");\n\n    String phoneNumber = Settings.getPhoneNumber().orElse(\"MY_SINCH_PHONE_NUMBER\");\n\n    Configuration configuration =\n        Configuration.builder()\n            .setProjectId(projectId)\n            .setKeyId(keyId)\n            .setKeySecret(keySecret)\n            .build();\n\n    SinchClient client = new SinchClient(configuration);\n\n    NumbersService numbersService = client.numbers().v1();\n\n    LOGGER.info(\"Get for: \" + phoneNumber);\n    ActiveNumber value = numbersService.get(phoneNumber);\n\n    LOGGER.info(\"Response: \" + value);\n  }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';\n  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';\n  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';\n\n  // The phone number you want to retrieve details for\n  const phoneNumber = process.env.SINCH_PHONE_NUMBER ?? 'MY_SINCH_PHONE_NUMBER';\n\n  const sinch = new SinchClient({ projectId, keyId, keySecret });\n\n  try{\n    const response = await sinch.numbers.get({ phoneNumber });\n    console.log('✅ Successfully retrieved the phone number details.');\n    console.log(JSON.stringify(response, null, 2));\n  } catch (err) {\n    console.error(`❌ Failed to retrieve the details for the phone number ${phoneNumber}:`);\n    console.error(err);\n  }\n}\n\nmain();\n"},{"lang":"Python","source":"\"\"\"\nSinch Python Snippet\n\nThis snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets\n\"\"\"\n\nimport os\nfrom dotenv import load_dotenv\nfrom sinch import SinchClient\n\nload_dotenv()\n\nsinch_client = SinchClient(\n    project_id=os.environ.get(\"SINCH_PROJECT_ID\") or \"MY_PROJECT_ID\",\n    key_id=os.environ.get(\"SINCH_KEY_ID\") or \"MY_KEY_ID\",\n    key_secret=os.environ.get(\"SINCH_KEY_SECRET\") or \"MY_KEY_SECRET\"\n)\n\n# The active phone number to retrieve details for in E.164 format\nphone_number = os.environ.get(\"SINCH_PHONE_NUMBER\") or \"MY_PHONE_NUMBER\"\n\nresponse = sinch_client.numbers.get(phone_number=phone_number)\n\nprint(f\"Rented number details:\\n{response}\")\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A successful response, or an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/error-codes/status-codes/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActiveNumberResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateFaxNumber"]}},"schemaId":"components/schemas/ActiveNumberResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateFaxNumber"]},{"code":"400","description":"400 Invalid Argument error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}},"schemaId":"components/schemas/InvalidArgument"},{"code":"404","description":"404 Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActiveNumberResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateFaxNumber"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActiveNumberResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateFaxNumber"]}}},{"code":"400","schemaId":"components/schemas/InvalidArgument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/active-number/numberservice_getactivenumber"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}"},{"label":"Release an active number from the project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/active-number/numberservice_releasenumber","routeSlug":"/docs/numbers/api-reference/numbers/active-number/numberservice_releasenumber","metadata":{"seo":{"title":"Release an active number from the project","description":"With this endpoint, you can cancel your subscription for a specific phone number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"NumberService_ReleaseNumber","name":"Release an active number from the project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Release an active number from the project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"With this endpoint, you can cancel your subscription for a specific phone number."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true},{"name":"phoneNumber","in":"path","schemaId":"schema_698","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output only. The phone number in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://community.sinch.com/t5/Glossary/E-164/ta-p/7537"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with leading "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}:release","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"},{"name":"phoneNumber","in":"path","required":true,"example":"+12025550134","schemaId":"schema_698"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","403","404","500"],"pointer":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}:release","href":"active-number/numberservice_releasenumber","openApiOperationId":"NumberService_ReleaseNumber","summary":"Release an active number from the project","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"definitionSamples":[{"lang":"Java","source":"/**\n * Sinch Java Snippet\n *\n * <p>This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n * <p>See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage numbers;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.numbers.api.v1.NumbersService;\nimport com.sinch.sdk.domains.numbers.models.v1.ActiveNumber;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class Release {\n\n  private static final Logger LOGGER = Logger.getLogger(Release.class.getName());\n\n  public static void main(String[] args) {\n\n    String projectId = Settings.getProjectId().orElse(\"MY_PROJECT_ID\");\n    String keyId = Settings.getKeyId().orElse(\"MY_KEY_ID\");\n    String keySecret = Settings.getKeySecret().orElse(\"MY_KEY_SECRET\");\n\n    String phoneNumber = Settings.getPhoneNumber().orElse(\"MY_SINCH_PHONE_NUMBER\");\n\n    Configuration configuration =\n        Configuration.builder()\n            .setProjectId(projectId)\n            .setKeyId(keyId)\n            .setKeySecret(keySecret)\n            .build();\n\n    SinchClient client = new SinchClient(configuration);\n\n    NumbersService numbersService = client.numbers().v1();\n\n    LOGGER.info(\"Release for: \" + phoneNumber);\n\n    ActiveNumber value = numbersService.release(phoneNumber);\n\n    LOGGER.info(\"Response: \" + value);\n  }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';\n  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';\n  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';\n\n  // The phone number to release\n  const phoneNumber = process.env.SINCH_PHONE_NUMBER ?? 'MY_SINCH_PHONE_NUMBER';\n\n  const sinch = new SinchClient({ projectId, keyId, keySecret });\n\n  try {\n    const response = await sinch.numbers.release({ phoneNumber });\n    console.log('✅ Successfully released the phone number.');\n    console.log(JSON.stringify(response, null, 2));\n  } catch (err) {\n    console.error(`❌ Failed to release the phone number ${phoneNumber}:`);\n    console.error(err);\n  }\n}\n\nmain();\n"},{"lang":"Python","source":"\"\"\"\nSinch Python Snippet\n\nThis snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets\n\"\"\"\n\nimport os\nfrom dotenv import load_dotenv\nfrom sinch import SinchClient\n\nload_dotenv()\n\nsinch_client = SinchClient(\n    project_id=os.environ.get(\"SINCH_PROJECT_ID\") or \"MY_PROJECT_ID\",\n    key_id=os.environ.get(\"SINCH_KEY_ID\") or \"MY_KEY_ID\",\n    key_secret=os.environ.get(\"SINCH_KEY_SECRET\") or \"MY_KEY_SECRET\"\n)\n\n# The phone number to release in E.164 format\nphone_number = os.environ.get(\"SINCH_PHONE_NUMBER\") or \"MY_SINCH_PHONE_NUMBER\"\n\nreleased_number = sinch_client.numbers.release(\n    phone_number=phone_number\n)\n\nprint(\"Released Number:\", released_number)\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A successful response, or an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/error-codes/status-codes/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActiveNumberResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateFaxNumber"]}},"schemaId":"components/schemas/ActiveNumberResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateFaxNumber"]},{"code":"400","description":"400 Invalid Argument error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}},"schemaId":"components/schemas/InvalidArgument"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERMISSION_DENIED: improper credentials. Be sure your projectId, username and password are correct."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/403/content/application~1json/example"]},{"code":"404","description":"404 Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActiveNumberResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateFaxNumber"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActiveNumberResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateSMSNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateVoiceNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateESTNumber","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateFaxNumber"]}}},{"code":"400","schemaId":"components/schemas/InvalidArgument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}}},{"code":"403","schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/active-number/numberservice_releasenumber"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}:release"},{"label":"Get the emergency address for a number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/active-number/numberservice_getemergencyaddress","routeSlug":"/docs/numbers/api-reference/numbers/active-number/numberservice_getemergencyaddress","metadata":{"seo":{"title":"Get the emergency address for a number","description":"With this endpoint, you can retrieve the emergency address associated with this number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"NumberService_GetEmergencyAddress","name":"Get the emergency address for a number","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the emergency address for a number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"With this endpoint, you can retrieve the emergency address associated with this number."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true},{"name":"phoneNumber","in":"path","schemaId":"schema_698","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output only. The phone number in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://community.sinch.com/t5/Glossary/E-164/ta-p/7537"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with leading "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}/emergencyAddress","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"},{"name":"phoneNumber","in":"path","required":true,"example":"+12025550134","schemaId":"schema_698"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","403","404","500"],"pointer":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}/emergencyAddress","href":"active-number/numberservice_getemergencyaddress","openApiOperationId":"NumberService_GetEmergencyAddress","summary":"Get the emergency address for a number","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"definitionSamples":[{"lang":"Java","source":"/**\n * Sinch Java Snippet\n *\n * <p>This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n * <p>See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage numbers;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.numbers.api.v1.NumbersService;\nimport com.sinch.sdk.domains.numbers.models.v1.EmergencyAddress;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class GetEmergencyAddress {\n  private static final Logger LOGGER = Logger.getLogger(GetEmergencyAddress.class.getName());\n\n  public static void main(String[] args) {\n\n    String projectId = Settings.getProjectId().orElse(\"MY_PROJECT_ID\");\n    String keyId = Settings.getKeyId().orElse(\"MY_KEY_ID\");\n    String keySecret = Settings.getKeySecret().orElse(\"MY_KEY_SECRET\");\n\n    String phoneNumber = Settings.getPhoneNumber().orElse(\"MY_SINCH_PHONE_NUMBER\");\n\n    Configuration configuration =\n        Configuration.builder()\n            .setProjectId(projectId)\n            .setKeyId(keyId)\n            .setKeySecret(keySecret)\n            .build();\n\n    SinchClient client = new SinchClient(configuration);\n\n    NumbersService numbersService = client.numbers().v1();\n\n    LOGGER.info(\"Get EmergencyAddress for: \" + phoneNumber);\n\n    EmergencyAddress response = numbersService.getEmergencyAddress(phoneNumber);\n\n    LOGGER.info(\"Response: \" + response);\n  }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';\n  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';\n  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';\n\n  // The phone number for which you want to retrieve the emergency address\n  const phoneNumber = process.env.SINCH_PHONE_NUMBER ?? 'MY_SINCH_PHONE_NUMBER';\n\n  const sinch = new SinchClient({ projectId, keyId, keySecret });\n\n  try{\n    const response = await sinch.numbers.getEmergencyAddress({ phoneNumber });\n    console.log(`✅ Successfully retrieved the Emergency Address for the phone number ${phoneNumber}.`);\n    console.log(JSON.stringify(response, null, 2));\n  } catch (err) {\n    console.error(`❌ Failed to retrieve the Emergency Address for the phone number ${phoneNumber}:`);\n    console.error(err);\n  }\n}\n\nmain();\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A successful response, or an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/error-codes/status-codes/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmergencyAddress"}},"schemaId":"components/schemas/EmergencyAddress"},{"code":"400","description":"400 Invalid Argument error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}},"schemaId":"components/schemas/InvalidArgument"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERMISSION_DENIED: improper credentials. Be sure your projectId, username and password are correct."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress/get/responses/403/content/application~1json/example"]},{"code":"404","description":"404 Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmergencyAddress","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmergencyAddress"}}},{"code":"400","schemaId":"components/schemas/InvalidArgument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}}},{"code":"403","schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/active-number/numberservice_getemergencyaddress"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}/emergencyAddress"},{"label":"Add a emergency address for a number","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/active-number/numberservice_provisionemergencyaddress","routeSlug":"/docs/numbers/api-reference/numbers/active-number/numberservice_provisionemergencyaddress","metadata":{"seo":{"title":"Add a emergency address for a number","description":"With this endpoint, you can provision an emergency address associated with this number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"NumberService_ProvisionEmergencyAddress","name":"Add a emergency address for a number","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:provision/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a emergency address for a number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"With this endpoint, you can provision an emergency address associated with this number."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true},{"name":"phoneNumber","in":"path","schemaId":"schema_698","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output only. The phone number in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://community.sinch.com/t5/Glossary/E-164/ta-p/7537"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with leading "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:provision/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmergencyAddressRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:provision/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/EmergencyAddressRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:provision/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:provision/post/requestBody","description":"Request to provision an emergency address for a number."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}/emergencyAddress:provision","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"},{"name":"phoneNumber","in":"path","required":true,"example":"+12025550134","schemaId":"schema_698"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EmergencyAddressRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:provision/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","403","404","500"],"pointer":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}/emergencyAddress:provision","href":"active-number/numberservice_provisionemergencyaddress","openApiOperationId":"NumberService_ProvisionEmergencyAddress","summary":"Add a emergency address for a number","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"definitionSamples":[{"lang":"Java","source":"/**\n * Sinch Java Snippet\n *\n * <p>This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n * <p>See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage numbers;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.numbers.api.v1.NumbersService;\nimport com.sinch.sdk.domains.numbers.models.v1.EmergencyAddress;\nimport com.sinch.sdk.domains.numbers.models.v1.request.EmergencyAddressRequest;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class ProvisionEmergencyAddress {\n\n  private static final Logger LOGGER = Logger.getLogger(ProvisionEmergencyAddress.class.getName());\n\n  public static void main(String[] args) {\n\n    String projectId = Settings.getProjectId().orElse(\"MY_PROJECT_ID\");\n    String keyId = Settings.getKeyId().orElse(\"MY_KEY_ID\");\n    String keySecret = Settings.getKeySecret().orElse(\"MY_KEY_SECRET\");\n\n    String phoneNumber = Settings.getPhoneNumber().orElse(\"MY_SINCH_PHONE_NUMBER\");\n\n    Configuration configuration =\n        Configuration.builder()\n            .setProjectId(projectId)\n            .setKeyId(keyId)\n            .setKeySecret(keySecret)\n            .build();\n\n    SinchClient client = new SinchClient(configuration);\n\n    NumbersService numbersService = client.numbers().v1();\n\n    LOGGER.info(\"Provisioning EmergencyAddress for: \" + phoneNumber);\n\n    EmergencyAddress emergencyAddress =\n        EmergencyAddress.builder()\n            .setStreetNumber(\"3500\")\n            .setStreetInfo(\"Lenox Rd NE\")\n            .setCity(\"Atlanta\")\n            .setState(\"GA\")\n            .setPostalCode(\"30326\")\n            .build();\n\n    EmergencyAddressRequest request =\n        EmergencyAddressRequest.builder()\n            .setDisplayName(\"Emergency Address Display Name\")\n            .setAddress(emergencyAddress)\n            .build();\n    EmergencyAddress value = numbersService.provisionEmergencyAddress(phoneNumber, request);\n\n    LOGGER.info(\"Response: \" + value);\n  }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';\n  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';\n  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';\n\n  // The phone number you want to provision an emergency address for\n  const phoneNumber = process.env.SINCH_PHONE_NUMBER ?? 'MY_SINCH_PHONE_NUMBER';\n\n  const sinch = new SinchClient({ projectId, keyId, keySecret });\n\n  try{\n    const response = await sinch.numbers.provisionEmergencyAddress({\n      phoneNumber,\n      emergencyAddressRequestBody: {\n        displayName: 'Emergency Address Display Name',\n        address: {\n          streetNumber: '3500',\n          streetInfo: 'Lenox Rd NE',\n          city: 'Atlanta',\n          state: 'GA',\n          postalCode: '30326',\n        },\n      },\n    });\n    console.log(`✅ Successfully provisioned an emergency address for the phone number ${phoneNumber}.`);\n    console.log(JSON.stringify(response, null, 2));\n  } catch (err) {\n    console.error(`❌ Failed to provision an emergency address for the phone number ${phoneNumber}:`);\n    console.error(err);\n  }\n}\n\nmain();\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"schemaId":"components/schemas/EmergencyAddressRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:provision/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmergencyAddressRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:provision/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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A successful response, or an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/error-codes/status-codes/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmergencyAddress"}},"schemaId":"components/schemas/EmergencyAddress"},{"code":"400","description":"400 Invalid Argument error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}},"schemaId":"components/schemas/InvalidArgument"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERMISSION_DENIED: improper credentials. Be sure your projectId, username and password are correct."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:provision/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:provision/post/responses/403/content/application~1json/example"]},{"code":"404","description":"404 Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:provision/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmergencyAddress","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmergencyAddress"}}},{"code":"400","schemaId":"components/schemas/InvalidArgument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}}},{"code":"403","schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:provision/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:provision/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/active-number/numberservice_provisionemergencyaddress"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}/emergencyAddress:provision"},{"label":"Remove the emergency address for a number.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/active-number/numberservice_deprovisionemergencyaddress","routeSlug":"/docs/numbers/api-reference/numbers/active-number/numberservice_deprovisionemergencyaddress","metadata":{"seo":{"title":"Remove the emergency address for a number.","description":"With this endpoint, you can deprovision the emergency address associated with this number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"NumberService_DeprovisionEmergencyAddress","name":"Remove the emergency address for a number.","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:deprovision/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove the emergency address for a number.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"With this endpoint, you can deprovision the emergency address associated with this number."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true},{"name":"phoneNumber","in":"path","schemaId":"schema_698","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output only. The phone number in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://community.sinch.com/t5/Glossary/E-164/ta-p/7537"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with leading "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:deprovision/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}/emergencyAddress:deprovision","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"},{"name":"phoneNumber","in":"path","required":true,"example":"+12025550134","schemaId":"schema_698"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","403","404","500"],"pointer":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}/emergencyAddress:deprovision","href":"active-number/numberservice_deprovisionemergencyaddress","openApiOperationId":"NumberService_DeprovisionEmergencyAddress","summary":"Remove the emergency address for a number.","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"definitionSamples":[{"lang":"Java","source":"/**\n * Sinch Java Snippet\n *\n * <p>This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n * <p>See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage numbers;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.numbers.api.v1.NumbersService;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class DeprovisionEmergencyAddress {\n  private static final Logger LOGGER =\n      Logger.getLogger(DeprovisionEmergencyAddress.class.getName());\n\n  public static void main(String[] args) {\n\n    String projectId = Settings.getProjectId().orElse(\"MY_PROJECT_ID\");\n    String keyId = Settings.getKeyId().orElse(\"MY_KEY_ID\");\n    String keySecret = Settings.getKeySecret().orElse(\"MY_KEY_SECRET\");\n\n    String phoneNumber = Settings.getPhoneNumber().orElse(\"MY_SINCH_PHONE_NUMBER\");\n\n    Configuration configuration =\n        Configuration.builder()\n            .setProjectId(projectId)\n            .setKeyId(keyId)\n            .setKeySecret(keySecret)\n            .build();\n\n    SinchClient client = new SinchClient(configuration);\n\n    NumbersService numbersService = client.numbers().v1();\n\n    LOGGER.info(\"De-provisioning EmergencyAddress for: \" + phoneNumber);\n\n    numbersService.deprovisionEmergencyAddress(phoneNumber);\n  }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';\n  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';\n  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';\n\n  // The phone number you want to remove the emergency address from\n  const phoneNumber = process.env.SINCH_PHONE_NUMBER ?? 'MY_SINCH_PHONE_NUMBER';\n\n  const sinch = new SinchClient({ projectId, keyId, keySecret });\n\n  try{\n    await sinch.numbers.deprovisionEmergencyAddress({ phoneNumber });\n    console.log(`✅ Successfully deprovisioned the emergency address from the phone number ${phoneNumber}.`);\n  } catch (err) {\n    console.error(`❌ Failed to deprovision the emergency address from the phone number ${phoneNumber}:`);\n    console.error(err);\n  }\n}\n\nmain();\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A successful response, or an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/error-codes/status-codes/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error"},"children":[]}]}]}]}]},{"code":"400","description":"400 Invalid Argument error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}},"schemaId":"components/schemas/InvalidArgument"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERMISSION_DENIED: improper credentials. Be sure your projectId, username and password are correct."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:deprovision/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:deprovision/post/responses/403/content/application~1json/example"]},{"code":"404","description":"404 Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:deprovision/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/InvalidArgument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}}},{"code":"403","schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:deprovision/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:deprovision/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/active-number/numberservice_deprovisionemergencyaddress"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}/emergencyAddress:deprovision"},{"label":"Validate the emergency address for a number.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/active-number/numberservice_validateemergencyaddress","routeSlug":"/docs/numbers/api-reference/numbers/active-number/numberservice_validateemergencyaddress","metadata":{"seo":{"title":"Validate the emergency address for a number.","description":"With this endpoint, you can validate the emergency address associated with this number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"NumberService_ValidateEmergencyAddress","name":"Validate the emergency address for a number.","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate the emergency address for a number.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"With this endpoint, you can validate the emergency address associated with this number."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true},{"name":"phoneNumber","in":"path","schemaId":"schema_698","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output only. The phone number in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://community.sinch.com/t5/Glossary/E-164/ta-p/7537"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with leading "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmergencyAddressRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/EmergencyAddressRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/requestBody","description":"Request to validate an emergency address for a number."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}/emergencyAddress:validate","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"},{"name":"phoneNumber","in":"path","required":true,"example":"+12025550134","schemaId":"schema_698"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EmergencyAddressRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","404","500"],"pointer":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}/emergencyAddress:validate","href":"active-number/numberservice_validateemergencyaddress","openApiOperationId":"NumberService_ValidateEmergencyAddress","summary":"Validate the emergency address for a number.","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"definitionSamples":[{"lang":"Java","source":"/**\n * Sinch Java Snippet\n *\n * <p>This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n * <p>See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage numbers;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.numbers.api.v1.NumbersService;\nimport com.sinch.sdk.domains.numbers.models.v1.EmergencyAddress;\nimport com.sinch.sdk.domains.numbers.models.v1.request.EmergencyAddressRequest;\nimport com.sinch.sdk.domains.numbers.models.v1.response.ValidateAddressResponse;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class ValidateEmergencyAddress {\n  private static final Logger LOGGER = Logger.getLogger(ValidateEmergencyAddress.class.getName());\n\n  public static void main(String[] args) {\n\n    String projectId = Settings.getProjectId().orElse(\"MY_PROJECT_ID\");\n    String keyId = Settings.getKeyId().orElse(\"MY_KEY_ID\");\n    String keySecret = Settings.getKeySecret().orElse(\"MY_KEY_SECRET\");\n\n    String phoneNumber = Settings.getPhoneNumber().orElse(\"MY_SINCH_PHONE_NUMBER\");\n\n    Configuration configuration =\n        Configuration.builder()\n            .setProjectId(projectId)\n            .setKeyId(keyId)\n            .setKeySecret(keySecret)\n            .build();\n\n    SinchClient client = new SinchClient(configuration);\n\n    NumbersService numbersService = client.numbers().v1();\n\n    LOGGER.info(\"Validate EmergencyAddress for: \" + phoneNumber);\n\n    EmergencyAddress emergencyAddress =\n        EmergencyAddress.builder()\n            .setStreetNumber(\"3500\")\n            .setStreetInfo(\"Lenox Road NE\")\n            .setCity(\"Atlanta\")\n            .setState(\"GA\")\n            .setPostalCode(\"30326\")\n            .build();\n\n    EmergencyAddressRequest request =\n        EmergencyAddressRequest.builder()\n            .setDisplayName(\"Emergency Address Display Name\")\n            .setAddress(emergencyAddress)\n            .build();\n    ValidateAddressResponse value = numbersService.validateEmergencyAddress(phoneNumber, request);\n\n    LOGGER.info(\"Response: \" + value);\n  }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';\n  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';\n  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';\n\n  // The phone number you want to validate an emergency address for\n  const phoneNumber = process.env.SINCH_PHONE_NUMBER ?? 'MY_SINCH_PHONE_NUMBER';\n\n  const sinch = new SinchClient({ projectId, keyId, keySecret });\n\n  try{\n    const response = await sinch.numbers.validateEmergencyAddress({\n      phoneNumber,\n      emergencyAddressRequestBody: {\n        displayName: 'Emergency Address Display Name',\n        address: {\n          streetNumber: '3500',\n          streetInfo: 'Lenox Rd NE',\n          city: 'Atlanta',\n          state: 'GA',\n          postalCode: '30326',\n        },\n      },\n    });\n    console.log('✅ Successfully submitted an emergency address validation.');\n    console.log(JSON.stringify(response, null, 2));\n  } catch (err) {\n    console.error(`❌ Failed to submit an emergency address validation for the phone number ${phoneNumber}:`);\n    console.error(err);\n  }\n}\n\nmain();\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"schemaId":"components/schemas/EmergencyAddressRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmergencyAddressRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A successful response, or an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/error-codes/status-codes/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidateAddressResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/responses/200/content/application~1json/examples/perfectMatch","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/responses/200/content/application~1json/examples/nearMatch","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/responses/200/content/application~1json/examples/noMatch"]}},"schemaId":"components/schemas/ValidateAddressResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/responses/200/content/application~1json/examples/perfectMatch","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/responses/200/content/application~1json/examples/nearMatch","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/responses/200/content/application~1json/examples/noMatch"]},{"code":"400","description":"400 Invalid Argument error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}},"schemaId":"components/schemas/InvalidArgument"},{"code":"404","description":"404 Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ValidateAddressResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/responses/200/content/application~1json/examples/perfectMatch","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/responses/200/content/application~1json/examples/nearMatch","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/responses/200/content/application~1json/examples/noMatch"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidateAddressResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/responses/200/content/application~1json/examples/perfectMatch","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/responses/200/content/application~1json/examples/nearMatch","paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/responses/200/content/application~1json/examples/noMatch"]}}},{"code":"400","schemaId":"components/schemas/InvalidArgument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/active-number/numberservice_validateemergencyaddress"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}/emergencyAddress:validate"}],"content":{"contentType":"group","meta":{"name":"Active Number"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Active Numbers","showPageActions":true},{"nodeType":"markdoc","content":"You can use the Active Number API to manage numbers you own. Release numbers from projects or list all numbers assigned to a project."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/activeNumbers","summary":"Lists active numbers for a project","prefix":{"name":"get","color":"get"},"badges":[],"link":"/active-number/numberservice_listactivenumbers","deprecated":false},{"title":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}","summary":"Update an active phone number","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/active-number/numberservice_updateactivenumber","deprecated":false},{"title":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}","summary":"Retrieve an active phone number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/active-number/numberservice_getactivenumber","deprecated":false},{"title":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}:release","summary":"Release an active number from the project","prefix":{"name":"post","color":"post"},"badges":[],"link":"/active-number/numberservice_releasenumber","deprecated":false},{"title":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}/emergencyAddress","summary":"Get the emergency address for a number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/active-number/numberservice_getemergencyaddress","deprecated":false},{"title":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}/emergencyAddress:provision","summary":"Add a emergency address for a number","prefix":{"name":"post","color":"post"},"badges":[],"link":"/active-number/numberservice_provisionemergencyaddress","deprecated":false},{"title":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}/emergencyAddress:deprovision","summary":"Remove the emergency address for a number.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/active-number/numberservice_deprovisionemergencyaddress","deprecated":false},{"title":"/v1/projects/{projectId}/activeNumbers/{phoneNumber}/emergencyAddress:validate","summary":"Validate the emergency address for a number.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/active-number/numberservice_validateemergencyaddress","deprecated":false}]}]}]}]}},{"type":"group","label":"Available Regions","link":"/docs/numbers/api-reference/numbers/available-regions","routeSlug":"/docs/numbers/api-reference/numbers/available-regions","items":[{"label":"List available regions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/available-regions/numberservice_listavailableregions","routeSlug":"/docs/numbers/api-reference/numbers/available-regions/numberservice_listavailableregions","metadata":{"seo":{"title":"List available regions","description":"Lists all regions for numbers provided for the project ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"NumberService_ListAvailableRegions","name":"List available regions","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1availableRegions/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List available regions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all regions for numbers provided for the project ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1availableRegions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"types","in":"query","schemaId":"schema_703","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only return regions for which numbers are provided with the given types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MOBILE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TOLL_FREE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MOBILE: Numbers that belong to a specific range."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCAL: Numbers that are assigned to a specific geographic region."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TOLL_FREE: Number that are free of charge for the calling party but billed for all arriving calls."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to see all results, do not add the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1projects~1{projectId}~1availableRegions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/availableRegions","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"}],"query":[{"name":"types","in":"query","required":false,"schemaId":"schema_703"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","403","404","500"],"pointer":"/v1/projects/{projectId}/availableRegions","href":"available-regions/numberservice_listavailableregions","openApiOperationId":"NumberService_ListAvailableRegions","summary":"List available regions","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"definitionSamples":[{"lang":"Java","source":"/**\n * Sinch Java Snippet\n *\n * <p>This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n * <p>See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage numbers.regions;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.numbers.api.v1.AvailableRegionsService;\nimport com.sinch.sdk.domains.numbers.models.v1.regions.response.AvailableRegionsListResponse;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class List {\n\n  private static final Logger LOGGER = Logger.getLogger(List.class.getName());\n\n  public static void main(String[] args) {\n\n    String projectId = Settings.getProjectId().orElse(\"MY_PROJECT_ID\");\n    String keyId = Settings.getKeyId().orElse(\"MY_KEY_ID\");\n    String keySecret = Settings.getKeySecret().orElse(\"MY_KEY_SECRET\");\n\n    Configuration configuration =\n        Configuration.builder()\n            .setProjectId(projectId)\n            .setKeyId(keyId)\n            .setKeySecret(keySecret)\n            .build();\n\n    SinchClient client = new SinchClient(configuration);\n\n    AvailableRegionsService availableRegionsService = client.numbers().v1().regions();\n\n    LOGGER.info(\"List\");\n\n    AvailableRegionsListResponse response = availableRegionsService.list();\n\n    LOGGER.info(\"Available regions:\");\n\n    response.iterator().forEachRemaining(item -> LOGGER.info(String.format(\"- %s\", item)));\n  }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';\n  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';\n  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';\n\n  const sinch = new SinchClient({ projectId, keyId, keySecret });\n\n  try{\n    const response = await sinch.numbers.availableRegions.list({});\n    if (!response.availableRegions?.length) {\n      console.log('No regions are available with these criteria.');\n      return;\n    }\n    console.log(`✅ Found ${response.availableRegions.length} available regions.`);\n    response.availableRegions.forEach((region) => {\n      console.log(region);\n    });\n  } catch (err) {\n    console.error('❌ Failed to list available regions:');\n    console.error(err);\n  }\n}\n\nmain();\n"},{"lang":"Python","source":"\"\"\"\nSinch Python Snippet\n\nThis snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets\n\"\"\"\n\nimport os\nfrom dotenv import load_dotenv\nfrom sinch import SinchClient\n\nload_dotenv()\n\nsinch_client = SinchClient(\n    project_id=os.environ.get(\"SINCH_PROJECT_ID\") or \"MY_PROJECT_ID\",\n    key_id=os.environ.get(\"SINCH_KEY_ID\") or \"MY_KEY_ID\",\n    key_secret=os.environ.get(\"SINCH_KEY_SECRET\") or \"MY_KEY_SECRET\"\n)\n\navailable_regions = sinch_client.numbers.regions.list(\n    number_types=[\"MOBILE\"]\n)\n\nprint(\"Available regions:\\n\")\nfor region in available_regions.iterator():\n    print(region)\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A successful response, or an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/error-codes/status-codes/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAvailableRegionsResponse"}},"schemaId":"components/schemas/ListAvailableRegionsResponse"},{"code":"400","description":"400 Invalid Argument error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}},"schemaId":"components/schemas/InvalidArgument"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERMISSION_DENIED: improper credentials. Be sure your projectId, username and password are correct."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableRegions/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableRegions/get/responses/403/content/application~1json/example"]},{"code":"404","description":"404 Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1availableRegions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListAvailableRegionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAvailableRegionsResponse"}}},{"code":"400","schemaId":"components/schemas/InvalidArgument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}}},{"code":"403","schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableRegions/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1availableRegions/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/available-regions/numberservice_listavailableregions"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/availableRegions"}],"content":{"contentType":"group","meta":{"name":"Available Regions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Available Regions","showPageActions":true},{"nodeType":"markdoc","content":"You can use the Available Regions API to list all of the regions that have numbers assigned to a project."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/availableRegions","summary":"List available regions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/available-regions/numberservice_listavailableregions","deprecated":false}]}]}]}]}},{"type":"group","label":"Numbers Callbacks","link":"/docs/numbers/api-reference/numbers/numbers-callbacks","routeSlug":"/docs/numbers/api-reference/numbers/numbers-callbacks","items":[{"type":"link","label":"Secure Webhook Endpoints with HMAC","link":"/docs/numbers/api-reference/numbers/numbers-callbacks/secure-webhook-endpoints-with-hmac","routeSlug":"/docs/numbers/api-reference/numbers/numbers-callbacks/secure-webhook-endpoints-with-hmac","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Secure Webhook Endpoints with HMAC"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"numbers-callbacks/secure-webhook-endpoints-with-hmac"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secure Webhook Endpoints with HMAC"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Implementing HMAC (Hash-based Message Authentication Code) on your webhook endpoints will ensure the integrity of data, preventing tampering during transmission."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An HMAC used in webhooks is a common approach in the industry and in a nutshell it is just special code that can be used to check if a message hasn't been tempered with during the transmission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend to configure an HMAC secret for your project using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/numbers/numbers-callbacks/updatecallbackconfiguration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"callback configuration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Then, when sending the number events, the HTTP POST requests will include the header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Sinch-Signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the computed HMAC."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The HMAC secret is configured per project; if you are using the Numbers API with multiple projects, make sure you configure the HMAC secret in each project, and fetch it for either imported or purchased numbers from the dedicated endpoints."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"HMAC verification","link":"/docs/numbers/api-reference/numbers/numbers-callbacks/hmac-verification","routeSlug":"/docs/numbers/api-reference/numbers/numbers-callbacks/hmac-verification","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"HMAC verification"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"numbers-callbacks/hmac-verification"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HMAC verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend to verify the HMAC code received with every event in your event handler. When receiving a new event on your endpoint URL, compute the HMAC of the payload using the secret (configured "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/numbers/numbers-callbacks/updatecallbackconfiguration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and compare it with one received in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Sinch-Signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Compute the HMAC on the plain text value before parsing the JSON payload."},"children":[]}]}]}]}],"panels":[]}]}},{"label":"Get callbacks configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/numbers-callbacks/getcallbackconfiguration","routeSlug":"/docs/numbers/api-reference/numbers/numbers-callbacks/getcallbackconfiguration","metadata":{"seo":{"title":"Get callbacks configuration","description":"Returns the callbacks configuration for the specified project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCallbackConfiguration","name":"Get callbacks configuration","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1callbackConfiguration/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get callbacks configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the callbacks configuration for the specified project"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1callbackConfiguration/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/callbackConfiguration","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","403","404","500"],"pointer":"/v1/projects/{projectId}/callbackConfiguration","href":"numbers-callbacks/getcallbackconfiguration","openApiOperationId":"GetCallbackConfiguration","summary":"Get callbacks configuration","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"definitionSamples":[{"lang":"Java","source":"/**\n * Sinch Java Snippet\n *\n * <p>This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n * <p>See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage numbers.eventdestinations;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.numbers.api.v1.EventDestinationsService;\nimport com.sinch.sdk.domains.numbers.models.v1.eventdestinations.response.EventDestinationResponse;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class Get {\n\n  private static final Logger LOGGER = Logger.getLogger(Get.class.getName());\n\n  public static void main(String[] args) {\n\n    String projectId = Settings.getProjectId().orElse(\"MY_PROJECT_ID\");\n    String keyId = Settings.getKeyId().orElse(\"MY_KEY_ID\");\n    String keySecret = Settings.getKeySecret().orElse(\"MY_KEY_SECRET\");\n\n    Configuration configuration =\n        Configuration.builder()\n            .setProjectId(projectId)\n            .setKeyId(keyId)\n            .setKeySecret(keySecret)\n            .build();\n\n    SinchClient client = new SinchClient(configuration);\n\n    EventDestinationsService eventDestinationsService = client.numbers().v1().eventDestinations();\n\n    LOGGER.info(\"Get\");\n\n    EventDestinationResponse value = eventDestinationsService.get();\n\n    LOGGER.info(\"Response :\" + value);\n  }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';\n  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';\n  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';\n\n  const sinch = new SinchClient({ projectId, keyId, keySecret });\n\n  try{\n    const response = await sinch.numbers.callbacks.get({});\n    console.log('✅ Successfully retrieved the callback configuration.');\n    console.log(JSON.stringify(response, null, 2));\n  } catch (err) {\n    console.error('❌ Failed to retrieve the callback configuration:');\n    console.error(err);\n  }\n}\n\nmain();\n"},{"lang":"Python","source":"\"\"\"\nSinch Python Snippet\n\nThis snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets\n\"\"\"\n\nimport os\nfrom dotenv import load_dotenv\nfrom sinch import SinchClient\n\nload_dotenv()\n\nsinch_client = SinchClient(\n    project_id=os.environ.get(\"SINCH_PROJECT_ID\") or \"MY_PROJECT_ID\",\n    key_id=os.environ.get(\"SINCH_KEY_ID\") or \"MY_KEY_ID\",\n    key_secret=os.environ.get(\"SINCH_KEY_SECRET\") or \"MY_KEY_SECRET\"\n)\n\nresponse = sinch_client.numbers.event_destinations.get()\n\nprint(\"Event Destination Configuration:\\n\", response)\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Callbacks configuration","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CallbackConfiguration"}},"schemaId":"components/schemas/CallbackConfiguration"},{"code":"400","description":"400 Invalid Argument error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}},"schemaId":"components/schemas/InvalidArgument"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERMISSION_DENIED: improper credentials. Be sure your projectId, username and password are correct."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1callbackConfiguration/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1callbackConfiguration/get/responses/403/content/application~1json/example"]},{"code":"404","description":"404 Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1callbackConfiguration/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CallbackConfiguration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CallbackConfiguration"}}},{"code":"400","schemaId":"components/schemas/InvalidArgument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}}},{"code":"403","schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1callbackConfiguration/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1callbackConfiguration/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/numbers-callbacks/getcallbackconfiguration"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/callbackConfiguration"},{"label":"Update callback configuration","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/numbers/numbers-callbacks/updatecallbackconfiguration","routeSlug":"/docs/numbers/api-reference/numbers/numbers-callbacks/updatecallbackconfiguration","metadata":{"seo":{"title":"Update callback configuration","description":"Updates the callbacks configuration for the specified project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateCallbackConfiguration","name":"Update callback configuration","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1callbackConfiguration/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update callback configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the callbacks configuration for the specified project"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_690","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settings > Projects."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1callbackConfiguration/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CallbackConfigurationUpdate"}},"schemaId":"components/schemas/CallbackConfigurationUpdate","pointer":"/paths/~1v1~1projects~1{projectId}~1callbackConfiguration/patch/requestBody","description":"The callback configuration details to be updated."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/projects/{projectId}/callbackConfiguration","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"YOUR_projectId","schemaId":"schema_690"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CallbackConfigurationUpdate"}},"responseCodes":["200","400","403","404","500"],"pointer":"/v1/projects/{projectId}/callbackConfiguration","href":"numbers-callbacks/updatecallbackconfiguration","openApiOperationId":"UpdateCallbackConfiguration","summary":"Update callback configuration","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"definitionSamples":[{"lang":"Java","source":"/**\n * Sinch Java Snippet\n *\n * <p>This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n * <p>See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage numbers.eventdestinations;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.numbers.api.v1.EventDestinationsService;\nimport com.sinch.sdk.domains.numbers.models.v1.eventdestinations.request.EventDestinationUpdateRequest;\nimport com.sinch.sdk.domains.numbers.models.v1.eventdestinations.response.EventDestinationResponse;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class Update {\n\n  private static final Logger LOGGER = Logger.getLogger(Update.class.getName());\n\n  public static void main(String[] args) {\n\n    String projectId = Settings.getProjectId().orElse(\"MY_PROJECT_ID\");\n    String keyId = Settings.getKeyId().orElse(\"MY_KEY_ID\");\n    String keySecret = Settings.getKeySecret().orElse(\"MY_KEY_SECRET\");\n\n    String hmac = \"NEW_HMAC_SECRET\";\n\n    Configuration configuration =\n        Configuration.builder()\n            .setProjectId(projectId)\n            .setKeyId(keyId)\n            .setKeySecret(keySecret)\n            .build();\n\n    SinchClient client = new SinchClient(configuration);\n\n    EventDestinationsService eventDestinationsService = client.numbers().v1().eventDestinations();\n\n    LOGGER.info(\"Update callback HMAC secret\");\n\n    EventDestinationUpdateRequest parameters =\n        EventDestinationUpdateRequest.builder().setHmacSecret(hmac).build();\n\n    EventDestinationResponse value = eventDestinationsService.update(parameters);\n\n    LOGGER.info(\"Response :\" + value);\n  }\n}\n"},{"lang":"Node.js","source":"/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';\n  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';\n  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';\n\n  // The new HMAC secret to configure for the callback\n  const hmacSecret = 'NEW_HMAC_SECRET';\n\n  const sinch = new SinchClient({ projectId, keyId, keySecret });\n\n  try{\n    const response = await sinch.numbers.callbacks.update({\n      updateCallbackConfigurationRequestBody: {\n        hmacSecret,\n      },\n    });\n    console.log('✅ Successfully updated the callback configuration.');\n    console.log(JSON.stringify(response, null, 2));\n  } catch (err) {\n    console.error('❌ Failed to update the callback configuration:');\n    console.error(err);\n  }\n}\n\nmain();\n"},{"lang":"Python","source":"\"\"\"\nSinch Python Snippet\n\nThis snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets\n\"\"\"\n\nimport os\nfrom dotenv import load_dotenv\nfrom sinch import SinchClient\n\nload_dotenv()\n\nsinch_client = SinchClient(\n    project_id=os.environ.get(\"SINCH_PROJECT_ID\") or \"MY_PROJECT_ID\",\n    key_id=os.environ.get(\"SINCH_KEY_ID\") or \"MY_KEY_ID\",\n    key_secret=os.environ.get(\"SINCH_KEY_SECRET\") or \"MY_KEY_SECRET\"\n)\n\n# The HMAC secret for signing webhook requests to your event destination\nhmac_secret = \"NEW_HMAC_SECRET\"\n\nresponse = sinch_client.numbers.event_destinations.update(\n    hmac_secret=hmac_secret\n)\n\nprint(\"Updated event destination configuration:\\n\", response)\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"schemaId":"components/schemas/CallbackConfigurationUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CallbackConfigurationUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Callback configuration","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CallbackConfiguration"}},"schemaId":"components/schemas/CallbackConfiguration"},{"code":"400","description":"400 Invalid Argument error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}},"schemaId":"components/schemas/InvalidArgument"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERMISSION_DENIED: improper credentials. Be sure your projectId, username and password are correct."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1callbackConfiguration/patch/responses/403/content/application~1json/example"]}},"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1callbackConfiguration/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"404 Not Found error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"500","description":"500 Internal Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}},"schemaId":"components/schemas/InternalError"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1callbackConfiguration/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CallbackConfiguration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CallbackConfiguration"}}},{"code":"400","schemaId":"components/schemas/InvalidArgument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidArgument"}}},{"code":"403","schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1callbackConfiguration/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1v1~1projects~1{projectId}~1callbackConfiguration/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"500","schemaId":"components/schemas/InternalError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/numbers-callbacks/updatecallbackconfiguration"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/callbackConfiguration"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Event notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/numbers/api-reference/numbers/numbers-callbacks/numberservice_eventscallback","routeSlug":"/docs/numbers/api-reference/numbers/numbers-callbacks/numberservice_eventscallback","metadata":{"seo":{"title":"Event notification","description":"A notification of an event sent to your configured callback URL."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"NumberService_EventsCallback","name":"Event notification","isWebhook":true,"pointer":"/paths/EventsCallback/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Event notification","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"A notification of an event sent to your configured callback URL."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Basic","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2.0","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CallbackPayload"}},"schemaId":"components/schemas/CallbackPayload","pointer":"/paths/EventsCallback/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"EventsCallback","servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Basic","type":"http","scheme":"basic"}],"scopes":[]},{"schemes":[{"id":"OAuth2.0","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CallbackPayload"}},"responseCodes":["default"],"pointer":"EventsCallback","href":"numbers-callbacks/numberservice_eventscallback","openApiOperationId":"NumberService_EventsCallback","summary":"Event notification","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"schemaId":"components/schemas/CallbackPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CallbackPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"default","description":"200 OK"}],"pointer":"/paths/EventsCallback/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/numbers-callbacks/numberservice_eventscallback"}],"panels":[]}]},"httpPath":"EventsCallback"}],"content":{"contentType":"group","meta":{"name":"Numbers Callbacks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Numbers Callbacks","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can set up callback URLs to receive event notifications when your numbers are updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When delivering events the order is not guaranteed (for example, a failed event scheduled for retry will not block other events that were queued)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The client's callback handler must implement the state machine that can decide what to do with "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unexpected"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events, for example, \"old\" events or invalid state transitions. In these cases the handler could use the API to GET the latest state for the resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The callback handler is expected to \"ingest\" the event and respond with 200 OK. The domain-specific business logic and processes should be executed outside of the callback request, as internal asynchronous jobs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Callbacks for all eventTypes - except NUMBER_ORDER_PROCESSING - will use 2 values for the status field: SUCCEEDED or FAILED. For NUMBER_ORDER_PROCESSING eventsTypes, the status field will reflect the Number Order state transition that happened, ex: IN_REVIEW, BLOCKED, COMPLETED, REJECTED, EXPIRED."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use callbacks, add the following IP addresses to your allowlist:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"54.76.19.159"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"54.78.194.39"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"54.155.83.128"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/callbackConfiguration","summary":"Get callbacks configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/numbers-callbacks/getcallbackconfiguration","deprecated":false},{"title":"/v1/projects/{projectId}/callbackConfiguration","summary":"Update callback configuration","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/numbers-callbacks/updatecallbackconfiguration","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"EventsCallback","summary":"Event notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/numbers-callbacks/numberservice_eventscallback","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/RentAnyNumberRequest":{"id":"components/schemas/RentAnyNumberRequest","kind":"json-schema","title":"RentAnyNumberRequest","data":{"title":"RentAnyNumberRequest","required":["regionCode","type"],"type":"object","properties":{"numberPattern":{"$ref":"#/components/schemas/NumberPattern"},"regionCode":{"allOf":[{"$ref":"#/components/schemas/RegionCode"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 country code of the phone number. This endpoint only supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"type":{"allOf":[{"$ref":"#/components/schemas/NumberType"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number type. This endpoint only supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"capabilities":{"type":"array","items":{"$ref":"#/components/schemas/NumberCapability"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number capabilities to filter by, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SMS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VOICE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"smsConfiguration":{"$ref":"#/components/schemas/smsConfiguration"},"voiceConfiguration":{"$ref":"#/components/schemas/VoiceConfiguration"},"callbackUrl":{"type":"string","description":"The callback URL to be called for a rented number's provisioning / deprovisioning operations.","example":"https://www.your-callback-server.com/callback"}},"description":"Request message for searching and renting in one go any number that matches the search criteria."}},"components/schemas/NumberPatternSearchPattern":{"id":"components/schemas/NumberPatternSearchPattern","kind":"json-schema","title":"Search Pattern","data":{"type":"string","enum":["START","CONTAINS","END"],"x-enumDescriptions":{"START":"Numbers that start with the provided sequence of digits.","CONTAINS":"Numbers that contain the sequence of digits entered.","END":"Numbers that end with the sequence of digits entered."},"description":"The pattern to apply to searches.","title":"Search Pattern"}},"components/schemas/money":{"id":"components/schemas/money","kind":"json-schema","title":"Money","data":{"type":"object","description":"An object giving details on currency code and the amount charged.","properties":{"currencyCode":{"type":"string","example":"USD","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 3-letter currency code defined in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"amount":{"type":"string","example":"2.00","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount in decimal form."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are no guarantees on the precision unless documented by the message origin. The amount cannot be updated and is read-only."},"children":[]}]}]}]}},"title":"Money"}},"components/schemas/ActiveNumberRequest":{"id":"components/schemas/ActiveNumberRequest","kind":"json-schema","title":"Active Number Request","data":{"type":"object","properties":{"displayName":{"type":"string","description":"User supplied name for the phone number."},"smsConfiguration":{"$ref":"#/components/schemas/smsConfiguration"},"voiceConfiguration":{"$ref":"#/components/schemas/VoiceConfiguration"},"callbackUrl":{"type":"string","description":"The callback URL to be called for a rented number's provisioning / deprovisioning operations."}},"description":"The phone number that has been rented by a customer and assigned to a project.","title":"Active Number Request"}},"components/schemas/ActiveNumberResponse":{"id":"components/schemas/ActiveNumberResponse","kind":"json-schema","title":"Active Number Response","data":{"type":"object","properties":{"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber"},"projectId":{"type":"string","example":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Project ID. Your project ID can be found on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/project-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"displayName":{"type":"string","description":"User supplied name for the phone number."},"regionCode":{"$ref":"#/components/schemas/RegionCode"},"type":{"$ref":"#/components/schemas/NumberType"},"capability":{"description":"The capability of the number.","type":"array","example":["SMS"],"items":{"$ref":"#/components/schemas/NumberCapability"}},"money":{"$ref":"#/components/schemas/money"},"paymentIntervalMonths":{"type":"integer","format":"int32","description":"How often the recurring price is charged in months.","readOnly":true},"nextChargeDate":{"type":"string","format":"date-time","description":"The date of the next charge.","readOnly":true},"expireAt":{"type":"string","format":"date-time","description":"The timestamp when the subscription will expire if an expiration date has been set.","readOnly":true},"smsConfiguration":{"$ref":"#/components/schemas/smsConfiguration"},"voiceConfiguration":{"$ref":"#/components/schemas/VoiceConfiguration"},"callbackUrl":{"type":"string","description":"The callback URL to be called for a rented number's provisioning / deprovisioning operations.","example":"https://www.your-callback-server.com/callback"}},"description":"The phone number that has been bought by a customer and assigned to a project.","title":"Active Number Response"}},"components/schemas/AvailableNumber":{"id":"components/schemas/AvailableNumber","kind":"json-schema","title":"Available Number","data":{"type":"object","properties":{"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber"},"regionCode":{"$ref":"#/components/schemas/RegionCode"},"type":{"$ref":"#/components/schemas/NumberType"},"capability":{"type":"array","description":"The capability of the number.","example":["SMS","VOICE"],"items":{"$ref":"#/components/schemas/NumberCapability"}},"setupPrice":{"$ref":"#/components/schemas/money"},"monthlyPrice":{"$ref":"#/components/schemas/money"},"paymentIntervalMonths":{"type":"integer","format":"int32","description":"How often the recurring price is charged in months.","readOnly":true},"supportingDocumentationRequired":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether regulations in the number's region require supplementary documentation (for example, business or identity documents) to buy numbers of this type. The value is determined by the regulatory requirements for the number's region and number type, so it's the same for every number of that type in that region."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/numbers/number-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API to buy the number: call \"Lookup number requirements\" to find out exactly which information and documents are required, then provide them with the order's registration and attachment endpoints before submitting the order."},"children":[]}]}]}],"readOnly":true}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The phone numbers that are available to be rented in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/numbers/buy-numbers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dashboard.sinch.com"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or via the public numbers API."},"children":[]}]}]}],"title":"Available Number"}},"components/schemas/AvailableRegion":{"id":"components/schemas/AvailableRegion","kind":"json-schema","title":"Available Region","data":{"type":"object","properties":{"regionCode":{"$ref":"#/components/schemas/RegionCode"},"regionName":{"type":"string","example":"United States","description":"Display name of the region. Examples: United States, United Kingdom or Sweden.","readOnly":true},"types":{"type":"array","example":["MOBILE"],"items":{"$ref":"#/components/schemas/NumberType"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of the different number types available. Examples: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MOBILE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"readOnly":true}},"description":"A region for which numbers are provided.","title":"Available Region"}},"components/schemas/ListActiveNumbersResponse":{"id":"components/schemas/ListActiveNumbersResponse","kind":"json-schema","title":"Active Numbers Response","data":{"type":"object","properties":{"activeNumbers":{"type":"array","items":{"$ref":"#/components/schemas/ActiveNumberResponse"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of numbers associated to the client project specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ListActiveNumbers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"nextPageToken":{"type":"string","title":"The token to be used for listing the next page."},"totalSize":{"type":"integer","format":"int32","title":"The maximum number of results returned."}},"description":"Response message to list your active phone numbers.","title":"Active Numbers Response"}},"components/schemas/ListAvailableNumbersResponse":{"id":"components/schemas/ListAvailableNumbersResponse","kind":"json-schema","title":"Available Numbers Response","data":{"type":"object","properties":{"availableNumbers":{"type":"array","items":{"$ref":"#/components/schemas/AvailableNumber"},"description":"List of available phone numbers."}},"description":"Response message to list available phone numbers.","title":"Available Numbers Response"}},"components/schemas/ListAvailableRegionsResponse":{"id":"components/schemas/ListAvailableRegionsResponse","kind":"json-schema","title":"List Available Regions Response","data":{"type":"object","properties":{"availableRegions":{"type":"array","items":{"$ref":"#/components/schemas/AvailableRegion"},"title":"List of regions for which numbers are provided."}},"description":"Response message to list regions for which numbers are provided.","title":"List Available Regions Response"}},"components/schemas/NumberCapability":{"id":"components/schemas/NumberCapability","kind":"json-schema","title":"Capability","data":{"type":"string","enum":["SMS","VOICE"],"x-enumDescriptions":{"SMS":"The SMS product can use the number.","VOICE":"The Voice product can use the number."},"default":"SMS","description":"The capabilities the phone number supports: SMS, Voice, or both","title":"Capability"}},"components/schemas/NumberPattern":{"id":"components/schemas/NumberPattern","kind":"json-schema","title":"Search Pattern","data":{"type":"object","properties":{"pattern":{"type":"string","description":"Sequence of digits to search for."},"searchPattern":{"$ref":"#/components/schemas/NumberPatternSearchPattern"}},"title":"Search Pattern"}},"components/schemas/RegionCode":{"id":"components/schemas/RegionCode","kind":"json-schema","title":"Region Code","data":{"type":"string","example":"US","description":"ISO 3166-1 alpha-2 country code of the phone number. Example: US, GB or SE.","title":"Region Code","nullable":false}},"components/schemas/PhoneNumber":{"id":"components/schemas/PhoneNumber","kind":"json-schema","title":"Phone Number","data":{"type":"string","example":"+12025550134","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The phone number in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://community.sinch.com/t5/Glossary/E-164/ta-p/7537"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.164"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with leading "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+12025550134"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"title":"Phone Number"}},"components/schemas/NumberType":{"id":"components/schemas/NumberType","kind":"json-schema","title":"Type","data":{"type":"string","enum":["MOBILE","LOCAL","TOLL_FREE"],"x-enumDescriptions":{"MOBILE":"Numbers that belong to a specific range.","LOCAL":"Numbers that are assigned to a specific geographic region.","TOLL_FREE":"Numbers that are free of charge for the calling party but billed for all arriving calls."},"description":"The number type.","title":"Type","nullable":false}},"components/schemas/UploadStatus":{"id":"components/schemas/UploadStatus","kind":"json-schema","title":"Upload Status","data":{"default":"WAITING","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The attachment upload status. It will be either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAITING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["COMPLETED","WAITING","FAILED"],"x-enumDescriptions":{"WAITING":"Waiting for upload","COMPLETED":"Upload completed","FAILED":"Upload failed"},"title":"Upload Status"}},"components/schemas/ProvisioningStatus":{"id":"components/schemas/ProvisioningStatus","kind":"json-schema","title":"Provisioning Status","data":{"default":"WAITING","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The provisioning status. It will be either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAITING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the provisioning fails, a reason for the failure will be provided. [See a full list of provisioning error descriptions]<(https://developers.sinch.com/docs/numbers/api-reference/error-codes/provisioning-errors) and troubleshooting recommendations."},"children":[]}]}]}],"enum":["PROVISIONING_STATUS_UNSPECIFIED","WAITING","IN_PROGRESS","FAILED"],"x-enumDescriptions":{"PROVISIONING_STATUS_UNSPECIFIED":"The status is currently unknown.","WAITING":"Waiting for provisioning","IN_PROGRESS":"Provisioning in progress","FAILED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provisioning failed. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/error-codes/provisioning-errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provisioning error descriptions"},"children":[]}]}]}]}]},"title":"Provisioning Status"}},"components/schemas/RentNumberRequest":{"id":"components/schemas/RentNumberRequest","kind":"json-schema","title":"Rent Number Request","data":{"type":"object","properties":{"smsConfiguration":{"$ref":"#/components/schemas/smsConfiguration"},"voiceConfiguration":{"$ref":"#/components/schemas/VoiceConfiguration"},"callbackUrl":{"type":"string","description":"The callback URL to be called for a rented number's provisioning / deprovisioning operations."}},"description":"Request message for renting a phone number.","title":"Rent Number Request"}},"components/schemas/scheduledProvisioning":{"id":"components/schemas/scheduledProvisioning","kind":"json-schema","title":"Scheduled Provisioning","data":{"type":"object","description":"Represents the ongoing or failed scheduled provisioning job. This field will be empty if the number was both successfully provisioned to the SMS platform and linked to the 10DLC campaign.","properties":{"servicePlanId":{"type":"string","description":"The SMS service plan that the scheduled provisioning job will configure with the number.","readOnly":true},"campaignId":{"type":"string","description":"TCR campaign ID that the scheduled provisioning job will configure with the number.","readOnly":true},"status":{"$ref":"#/components/schemas/ProvisioningStatus"},"lastUpdatedTime":{"type":"string","format":"date-time","description":"Timestamp when the status was last updated.","readOnly":true},"errorCodes":{"type":"array","items":{"$ref":"#/components/schemas/SmsErrorCode"},"readOnly":true}},"title":"Scheduled Provisioning"}},"components/schemas/smsConfigurationBase":{"id":"components/schemas/smsConfigurationBase","kind":"json-schema","title":"Base SMS Configuration","data":{"title":"Base SMS Configuration","type":"object","required":["servicePlanId"],"properties":{"servicePlanId":{"type":"string","description":[{"$$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":"servicePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/sms/api/rest"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The service plan ID is what ties this number to the configured SMS service."},"children":[]}]}]}]},"campaignId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only for US phone numbers. This "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required to send SMS traffic to US; click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://community.sinch.com/t5/10DLC/What-is-10DLC/ta-p/7845"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to read more about 10DLC A2P messaging. So, it is the current campaign ID for this number. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is found on your TCR platform."},"children":[]}]}]}]}}}},"components/schemas/smsConfiguration":{"id":"components/schemas/smsConfiguration","kind":"json-schema","title":"SMS Configuration","data":{"type":"object","title":"SMS Configuration","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current SMS configuration for this number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"servicePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is sent, it enters scheduled provisioning."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of scheduled provisioning will show under a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledProvisioning"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object if it's still running. Once processed successfully, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"servicePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sent will appear directly under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smsConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/smsConfigurationBase"},{"type":"object","properties":{"scheduledProvisioning":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/scheduledProvisioning"}]}}}]}},"components/schemas/OrderSmsConfiguration":{"id":"components/schemas/OrderSmsConfiguration","kind":"json-schema","title":"KYC SMS Configuration","data":{"type":"object","title":"KYC SMS Configuration","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMS Configuration for KYC numbers, containing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"servicePlanId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/smsConfigurationBase"}]}},"components/schemas/LookupNumberRequirementsRequest":{"id":"components/schemas/LookupNumberRequirementsRequest","kind":"json-schema","title":"LookupNumberRequirementsRequest","data":{"type":"object","properties":{"regionCode":{"$ref":"#/components/schemas/RegionCode"},"numberType":{"$ref":"#/components/schemas/NumberType"}},"required":["regionCode","numberType"]}},"components/schemas/NumberRequirements":{"id":"components/schemas/NumberRequirements","kind":"json-schema","title":"NumberRequirements","data":{"type":"object","properties":{"fields":{"description":"Free-form JSON object of requirements.","type":"object","additionalProperties":true},"attachments":{"description":"List of attachments necessary to be uploaded as part of the KYC process","type":"array","items":{"$ref":"#/components/schemas/RequiredAttachment"}}}}},"components/schemas/CreateNumberOrderRequestBase":{"id":"components/schemas/CreateNumberOrderRequestBase","kind":"json-schema","title":"CreateNumberOrderRequestBase","data":{"type":"object","description":"Create a number order","properties":{"regionCode":{"$ref":"#/components/schemas/RegionCode"},"numberType":{"$ref":"#/components/schemas/NumberType"},"smsConfiguration":{"$ref":"#/components/schemas/OrderSmsConfiguration"},"voiceConfiguration":{"$ref":"#/components/schemas/OrderVoiceConfiguration"},"callbackUrl":{"type":"string","format":"uri"}},"required":["regionCode","numberType"]}},"components/schemas/CreateNumberOrderRequest":{"id":"components/schemas/CreateNumberOrderRequest","kind":"json-schema","title":"CreateNumberOrderRequest","data":{"allOf":[{"$ref":"#/components/schemas/CreateNumberOrderRequestBase"},{"oneOf":[{"title":"Order specific phone numbers","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order specific phone numbers using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberOrderOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only one phone number per order is currently supported."},"children":[]}]}]}],"properties":{"numberOrderOption":{"$ref":"#/components/schemas/CreateNumberOrderOption"}},"required":["numberOrderOption"]},{"title":"Order by quantity","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order between 1 and 100 numbers that match the given criteria using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantityOrderOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"quantityOrderOption":{"$ref":"#/components/schemas/CreateQuantityOrderOption"}},"required":["quantityOrderOption"]}]}]}},"components/schemas/CreateNumberOrderOption":{"id":"components/schemas/CreateNumberOrderOption","kind":"json-schema","title":"CreateNumberOrderOption","data":{"type":"object","properties":{"phoneNumbers":{"type":"array","description":"The phone numbers to order, in E.164 format. Although this is an array, only one phone number per order is currently supported.","minItems":1,"maxItems":1,"items":{"type":"string","description":"phone numbers in E.164 format","example":"+12311234567"}}}}},"components/schemas/CreateQuantityOrderOption":{"id":"components/schemas/CreateQuantityOrderOption","kind":"json-schema","title":"CreateQuantityOrderOption","data":{"type":"object","properties":{"numberPattern":{"$ref":"#/components/schemas/NumberPattern"},"requestedQuantity":{"type":"integer","format":"int32","description":"The number of phone numbers to order, between 1 and 100.","minimum":1,"maximum":100,"example":3},"sequential":{"type":"boolean"},"capabilities":{"type":"array","items":{"$ref":"#/components/schemas/NumberCapability"}}},"required":["requestedQuantity"]}},"components/schemas/NumberOrder":{"id":"components/schemas/NumberOrder","kind":"json-schema","title":"NumberOrder","data":{"type":"object","properties":{"projectId":{"type":"string","nullable":false},"idNumberOrder":{"type":"string","nullable":false},"regionCode":{"$ref":"#/components/schemas/RegionCode"},"state":{"$ref":"#/components/schemas/NumberOrderState"},"numberType":{"$ref":"#/components/schemas/NumberType"},"orderNumbers":{"type":"array","items":{"$ref":"#/components/schemas/OrderNumber"}},"smsConfiguration":{"$ref":"#/components/schemas/OrderSmsConfiguration"},"voiceConfiguration":{"$ref":"#/components/schemas/OrderVoiceConfiguration"},"expireTime":{"type":"string","format":"date-time","example":"2025-11-23T08:54:58.115Z","nullable":true},"createTime":{"type":"string","nullable":false,"format":"date-time"},"updateTime":{"type":"string","nullable":false,"format":"date-time"}}}},"components/schemas/NumberPrice":{"id":"components/schemas/NumberPrice","kind":"json-schema","title":"NumberPrice","data":{"type":"object","properties":{"setupPrice":{"$ref":"#/components/schemas/money"},"monthlyPrice":{"$ref":"#/components/schemas/money"},"paymentIntervalMonths":{"type":"integer","format":"int32"}}}},"components/schemas/OrderNumber":{"id":"components/schemas/OrderNumber","kind":"json-schema","title":"OrderNumber","data":{"type":"object","properties":{"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber"},"numberPrice":{"$ref":"#/components/schemas/NumberPrice"},"capabilities":{"type":"array","items":{"$ref":"#/components/schemas/NumberCapability"}}}}},"components/schemas/UpdateNumberOrderRegistrationRequest":{"id":"components/schemas/UpdateNumberOrderRegistrationRequest","kind":"json-schema","title":"UpdateNumberOrderRegistrationRequest","data":{"type":"object","properties":{"requestDetails":{"type":"object","additionalProperties":true,"description":"Free-form JSON object representing registration data."}}}},"components/schemas/Registration":{"id":"components/schemas/Registration","kind":"json-schema","title":"Registration","data":{"type":"object","properties":{"requestDetails":{"type":"object","additionalProperties":true,"description":"Free-form JSON object representing registration data."},"attachments":{"type":"array","description":"The attachments submitted for this registration, via the dedicated endpoint","items":{"$ref":"#/components/schemas/Attachment"}},"logs":{"type":"array","description":"A list of timestamped messages from our team with feedback regarding your submitted registration details, in ascending timestamp order","items":{"$ref":"#/components/schemas/RegistrationLog"}}}}},"components/schemas/RequiredAttachment":{"id":"components/schemas/RequiredAttachment","kind":"json-schema","title":"RequiredAttachment","data":{"type":"object","properties":{"id":{"type":"string","description":"ID  to be used when uploading the attachment for the registration via the \"Upload an attachment for a number order\" endpoint"},"description":{"type":"string","description":"Details about the attachment to be provided"},"mandatory":{"type":"boolean","description":"Indicates if this attachment's upload is mandatory when purchasing the phone number"},"template":{"type":"array","description":"Template to be used for the file attachment","items":{"$ref":"#/components/schemas/AttachmentTemplate"}},"title":{"type":"string","description":"Title of the attachment to be provided"},"allowedMimeTypes":{"description":"Array of allowed mime types. If empty, no restrictions are applied.","example":["application/pdf","application/pdf"],"type":"array","items":{"type":"string"}},"allowedDocumentTypes":{"description":"Document types allowed for this attachment. If specified, the documentType field in the attachment must be one of the allowed types.","example":["Passport","Driver's License"],"type":"array","items":{"type":"string"}}}}},"components/schemas/AttachmentTemplate":{"id":"components/schemas/AttachmentTemplate","kind":"json-schema","title":"AttachmentTemplate","data":{"type":"object","properties":{"name":{"type":"string","description":"Attachment template file name"},"url":{"type":"string","description":"URL where the template can be downloaded from"}}}},"components/schemas/Attachment":{"id":"components/schemas/Attachment","kind":"json-schema","title":"Attachment","data":{"type":"object","properties":{"attachmentId":{"type":"string"},"fileName":{"type":"string"},"mimeType":{"type":"string"},"createTime":{"type":"string","description":"Timestamp string (RFC3339).","format":"date-time"},"updateTime":{"type":"string","description":"Timestamp string (RFC3339).","format":"date-time"},"uploadStatus":{"$ref":"#/components/schemas/UploadStatus"},"documentType":{"type":"string"}}}},"components/schemas/RegistrationLog":{"id":"components/schemas/RegistrationLog","kind":"json-schema","title":"RegistrationLog","data":{"type":"object","properties":{"message":{"type":"string","description":"The feedback / message from our team"},"createTime":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp string (RFC3339). Indicates the date & time when the message was created."},"children":[]}]}]}],"format":"date-time"}}}},"components/schemas/NumberOrderState":{"id":"components/schemas/NumberOrderState","kind":"json-schema","title":"Number Order State","data":{"type":"string","x-enumDescriptions":{"NUMBER_ORDER_STATE_UNSPECIFIED":"State not specified.","CREATED":"Created state.","EXPIRED":"Expired state.","IN_REVIEW":"Order in review.","BLOCKED":"Order blocked.","REJECTED":"Order rejected.","COMPLETED":"Order completed."},"enum":["NUMBER_ORDER_STATE_UNSPECIFIED","CREATED","EXPIRED","IN_REVIEW","BLOCKED","REJECTED","COMPLETED"],"description":"The state of the number order","title":"Number Order State"}},"components/schemas/SmsErrorCode":{"id":"components/schemas/SmsErrorCode","kind":"json-schema","title":"SMS Error Code","data":{"type":"string","x-enumDescriptions":{"ERROR_CODE_UNSPECIFIED":"Code not specified.","INTERNAL_ERROR":"Internal server error.","SMS_PROVISIONING_FAILED":"Provisioning for SMS failed.","CAMPAIGN_PROVISIONING_FAILED":"Provisioning for campaign failed.","CAMPAIGN_NOT_AVAILABLE":"The specified campaign is not available.","EXCEEDED_10DLC_LIMIT":"Exceeded the 10DLC limit.","NUMBER_PROVISIONING_FAILED":"Failed to provision the number.","PARTNER_SERVICE_UNAVAILABLE":"The third party service is unavailable.","CAMPAIGN_PENDING_ACCEPTANCE":"The campaign is awaiting acceptance.","MNO_SHARING_ERROR":"Sharing error.","CAMPAIGN_EXPIRED":"The specific campaign has expired.","CAMPAIGN_MNO_REJECTED":"The MNO for the campaign was rejected.","CAMPAIGN_MNO_SUSPENDED":"The MNO for the campaign was suspended.","CAMPAIGN_MNO_REVIEW":"The MNO for the campaign is under review.","INSUFFICIENT_BALANCE":"The credit balance for the account is insufficient to cover the fees.","MOCK_CAMPAIGN_NOT_ALLOWED":"Mock campaign is not permitted.","TFN_NOT_ALLOWED":"The Toll-Free number is not allowed.","INVALID_NNID":"The specified NNID is invalid."},"enum":["ERROR_CODE_UNSPECIFIED","INTERNAL_ERROR","SMS_PROVISIONING_FAILED","CAMPAIGN_PROVISIONING_FAILED","CAMPAIGN_NOT_AVAILABLE","EXCEEDED_10DLC_LIMIT","NUMBER_PROVISIONING_FAILED","PARTNER_SERVICE_UNAVAILABLE","CAMPAIGN_PENDING_ACCEPTANCE","MNO_SHARING_ERROR","CAMPAIGN_EXPIRED","CAMPAIGN_MNO_REJECTED","CAMPAIGN_MNO_SUSPENDED","CAMPAIGN_MNO_REVIEW","INSUFFICIENT_BALANCE","MOCK_CAMPAIGN_NOT_ALLOWED","TFN_NOT_ALLOWED","INVALID_NNID"],"description":"The error codes that show the reason of failure of a scheduled provisioning","title":"SMS Error Code"}},"components/schemas/VoiceApplicationType":{"id":"components/schemas/VoiceApplicationType","kind":"json-schema","title":"VoiceApplicationType","data":{"type":"string","description":"The voice application type. Examples are RTC, EST, FAX","x-enumDescriptions":{"RTC":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Voice "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/voice"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see documentation"},"children":[]}]}]}]}],"EST":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Elastic SIP Trunking "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/est"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see documentation"},"children":[]}]}]}]}],"FAX":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAX application "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/fax/overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see documentation"},"children":[]}]}]}]}]},"enum":["RTC","EST","FAX"],"default":"RTC"}},"components/schemas/VoiceConfigurationCommon":{"id":"components/schemas/VoiceConfigurationCommon","kind":"json-schema","title":"Common VoiceConfiguration fields","data":{"title":"Common VoiceConfiguration fields","type":"object","properties":{"type":{"$ref":"#/components/schemas/VoiceApplicationType"},"lastUpdatedTime":{"type":"string","description":"Timestamp when the status was last updated.","format":"date-time","readOnly":true},"scheduledVoiceProvisioning":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ScheduledVoiceProvisioning"}]}}}},"components/schemas/VoiceTrunkId":{"id":"components/schemas/VoiceTrunkId","kind":"json-schema","title":"VoiceTrunkId","data":{"type":"object","properties":{"trunkId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The trunk ID if the type is EST. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trunkId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be found in your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/trunks/your-trunks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/VoiceServiceId":{"id":"components/schemas/VoiceServiceId","kind":"json-schema","title":"VoiceServiceId","data":{"type":"object","properties":{"serviceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The service ID if the type is FAX. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be found in your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/fax/services"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/VoiceAppId":{"id":"components/schemas/VoiceAppId","kind":"json-schema","title":"VoiceAppId","data":{"type":"object","properties":{"appId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your app ID for the Voice API. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be found in your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/voice/apps"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/VoiceConfigurationRTC":{"id":"components/schemas/VoiceConfigurationRTC","kind":"json-schema","title":"RTC VoiceConfiguration","data":{"title":"RTC VoiceConfiguration","type":"object","allOf":[{"$ref":"#/components/schemas/VoiceConfigurationCommon"},{"$ref":"#/components/schemas/VoiceAppId"}]}},"components/schemas/VoiceConfigurationEST":{"id":"components/schemas/VoiceConfigurationEST","kind":"json-schema","title":"EST VoiceConfiguration","data":{"title":"EST VoiceConfiguration","type":"object","required":["type"],"allOf":[{"$ref":"#/components/schemas/VoiceConfigurationCommon"},{"$ref":"#/components/schemas/VoiceTrunkId"}]}},"components/schemas/VoiceConfigurationFAX":{"id":"components/schemas/VoiceConfigurationFAX","kind":"json-schema","title":"FAX VoiceConfiguration","data":{"title":"FAX VoiceConfiguration","type":"object","required":["type"],"allOf":[{"$ref":"#/components/schemas/VoiceConfigurationCommon"},{"$ref":"#/components/schemas/VoiceServiceId"}]}},"components/schemas/VoiceConfiguration":{"id":"components/schemas/VoiceConfiguration","kind":"json-schema","title":"VoiceConfiguration","data":{"title":"VoiceConfiguration","type":"object","oneOf":[{"$ref":"#/components/schemas/VoiceConfigurationRTC"},{"$ref":"#/components/schemas/VoiceConfigurationEST"},{"$ref":"#/components/schemas/VoiceConfigurationFAX"}],"discriminator":{"propertyName":"type","mapping":{"RTC":"#/components/schemas/VoiceConfigurationRTC","EST":"#/components/schemas/VoiceConfigurationEST","FAX":"#/components/schemas/VoiceConfigurationFAX"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current voice configuration for this number. During scheduled provisioning, the app ID, service ID, or trunk ID value may be empty in a response if it is still processing or if it has failed. The status of scheduled provisioning will show under a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledVoiceProvisioning"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object if it's still running. Once processed successfully, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trunkId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sent will appear directly under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]}},"components/schemas/OrderVoiceConfigurationBase":{"id":"components/schemas/OrderVoiceConfigurationBase","kind":"json-schema","title":"OrderVoiceConfigurationBase","data":{"title":"OrderVoiceConfigurationBase","type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/VoiceApplicationType"}}}},"components/schemas/OrderVoiceConfigurationRTC":{"id":"components/schemas/OrderVoiceConfigurationRTC","kind":"json-schema","title":"OrderVoiceConfigurationRTC","data":{"title":"OrderVoiceConfigurationRTC","type":"object","allOf":[{"$ref":"#/components/schemas/OrderVoiceConfigurationBase"},{"$ref":"#/components/schemas/VoiceAppId"}]}},"components/schemas/OrderVoiceConfigurationEST":{"id":"components/schemas/OrderVoiceConfigurationEST","kind":"json-schema","title":"OrderVoiceConfigurationEST","data":{"title":"OrderVoiceConfigurationEST","type":"object","allOf":[{"$ref":"#/components/schemas/OrderVoiceConfigurationBase"},{"$ref":"#/components/schemas/VoiceConfigurationEST"}]}},"components/schemas/OrderVoiceConfigurationFAX":{"id":"components/schemas/OrderVoiceConfigurationFAX","kind":"json-schema","title":"OrderVoiceConfigurationFAX","data":{"title":"OrderVoiceConfigurationFAX","type":"object","allOf":[{"$ref":"#/components/schemas/OrderVoiceConfigurationBase"},{"$ref":"#/components/schemas/VoiceConfigurationFAX"}]}},"components/schemas/OrderVoiceConfiguration":{"id":"components/schemas/OrderVoiceConfiguration","kind":"json-schema","title":"OrderVoiceConfiguration","data":{"title":"OrderVoiceConfiguration","type":"object","oneOf":[{"$ref":"#/components/schemas/OrderVoiceConfigurationRTC"},{"$ref":"#/components/schemas/OrderVoiceConfigurationEST"},{"$ref":"#/components/schemas/OrderVoiceConfigurationFAX"}],"discriminator":{"propertyName":"type","mapping":{"RTC":"#/components/schemas/OrderVoiceConfigurationRTC","EST":"#/components/schemas/OrderVoiceConfigurationEST","FAX":"#/components/schemas/OrderVoiceConfigurationFAX"}}}},"components/schemas/ScheduledVoiceProvisioningCommon":{"id":"components/schemas/ScheduledVoiceProvisioningCommon","kind":"json-schema","title":"ScheduledVoiceProvisioningCommon","data":{"type":"object","required":["type"],"allOf":[{"type":"object","properties":{"type":{"$ref":"#/components/schemas/VoiceApplicationType"},"lastUpdatedTime":{"type":"string","description":"Timestamp when the status was last updated.","format":"date-time","readOnly":true},"status":{"$ref":"#/components/schemas/ProvisioningStatus"}}}]}},"components/schemas/ScheduledVoiceProvisioningEST":{"id":"components/schemas/ScheduledVoiceProvisioningEST","kind":"json-schema","title":"ScheduledVoiceProvisioningEST","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/ScheduledVoiceProvisioningCommon"},{"$ref":"#/components/schemas/VoiceTrunkId"}]}},"components/schemas/ScheduledVoiceProvisioningFAX":{"id":"components/schemas/ScheduledVoiceProvisioningFAX","kind":"json-schema","title":"ScheduledVoiceProvisioningFAX","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/ScheduledVoiceProvisioningCommon"},{"$ref":"#/components/schemas/VoiceServiceId"}]}},"components/schemas/ScheduledVoiceProvisioningRTC":{"id":"components/schemas/ScheduledVoiceProvisioningRTC","kind":"json-schema","title":"ScheduledVoiceProvisioningRTC","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/ScheduledVoiceProvisioningCommon"},{"$ref":"#/components/schemas/VoiceAppId"}]}},"components/schemas/ScheduledVoiceProvisioning":{"id":"components/schemas/ScheduledVoiceProvisioning","kind":"json-schema","title":"Scheduled Voice Provisioning","data":{"type":"object","readOnly":true,"description":"Represents the ongoing or failed scheduled voice provisioning job. This field will be empty if the number was successfully provisioned provisioned for voice.","required":["type"],"oneOf":[{"$ref":"#/components/schemas/ScheduledVoiceProvisioningEST"},{"$ref":"#/components/schemas/ScheduledVoiceProvisioningFAX"},{"$ref":"#/components/schemas/ScheduledVoiceProvisioningRTC"}],"discriminator":{"propertyName":"type","mapping":{"EST":"#/components/schemas/ScheduledVoiceProvisioningEST","FAX":"#/components/schemas/ScheduledVoiceProvisioningFAX","RTC":"#/components/schemas/ScheduledVoiceProvisioningRTC"}},"title":"Scheduled Voice Provisioning"}},"components/schemas/CallbackConfiguration":{"id":"components/schemas/CallbackConfiguration","kind":"json-schema","title":"CallbackConfiguration","data":{"description":"Response message containing the callbacks configuration for a specific project.","type":"object","properties":{"projectId":{"type":"string","description":"ID of the project the configuration belongs to.","example":"a99aa9aa-b888-777c-dd6d-ee55e5555555"},"hmacSecret":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The HMAC secret used for hashing the callback body using the HMAC-SHA1 algorithm - and for creating the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Sinch-Signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"example":"YOUR_hmac_secret"}}}},"components/schemas/CallbackConfigurationUpdate":{"id":"components/schemas/CallbackConfigurationUpdate","kind":"json-schema","title":"CallbackConfigurationUpdate","data":{"title":"CallbackConfigurationUpdate","type":"object","properties":{"hmacSecret":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The HMAC secret to be updated for the specified project. It must be between 32 and 64 characters, alphanumeric (A-Z, a-z, 0-9) and hyphens (-) only. Regex pattern: ^[a-zA-Z0-9-]{32,64}$"},"children":[]}]}]}]}},"description":"The request to update the callbacks configuration for the current project."}},"components/schemas/CallbackPayload":{"id":"components/schemas/CallbackPayload","kind":"json-schema","title":"CallbackPayload","data":{"type":"object","oneOf":[{"$ref":"#/components/schemas/CallbackPayloadActiveNumber"},{"$ref":"#/components/schemas/CallbackPayloadNumberOrder"}],"discriminator":{"propertyName":"resourceType","mapping":{"ACTIVE_NUMBER":"#/components/schemas/CallbackPayloadActiveNumber","NUMBER_ORDER":"#/components/schemas/CallbackPayloadNumberOrder"}}}},"components/schemas/CallbackPayloadActiveNumber":{"id":"components/schemas/CallbackPayloadActiveNumber","kind":"json-schema","title":"CallbackPayloadActiveNumber","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/CallbackPayloadCommon"}],"properties":{"eventType":{"type":"string","description":"The type of the event.","enum":["PROVISIONING_TO_SMS_PLATFORM","DEPROVISIONING_FROM_SMS_PLATFORM","PROVISIONING_TO_CAMPAIGN","DEPROVISIONING_FROM_CAMPAIGN","PROVISIONING_TO_VOICE_PLATFORM","DEPROVISIONING_FROM_VOICE_PLATFORM"],"x-enumDescriptions":{"PROVISIONING_TO_SMS_PLATFORM":"An event that occurs when a number is linked to a Service Plan ID.","DEPROVISIONING_FROM_SMS_PLATFORM":"An event that occurs when a number is unlinked from a Service Plan ID.","PROVISIONING_TO_CAMPAIGN":"An event that occurs when a number is linked to a Campaign.","DEPROVISIONING_FROM_CAMPAIGN":"An event that occurs when a number is unlinked from a Campaign.","PROVISIONING_TO_VOICE_PLATFORM":"An event that occurs when a number is enabled for Voice operations.","DEPROVISIONING_FROM_VOICE_PLATFORM":"An event that occurs when a number is disabled for Voice operations."},"example":"PROVISIONING_TO_CAMPAIGN"},"status":{"type":"string","description":"The status of the event or the state transition it represents.","x-enumDescriptions":{"SUCCEEDED":"The event has succeeded.","FAILED":"The event has failed."},"enum":["SUCCEEDED","FAILED"],"example":"FAILED"},"failureCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the status is FAILED, a failure code will be provided. For numbers provisioning to SMS platform, there won't be any extra "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failureCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", as the result is binary. For campaign provisioning-related failures, refer to the list for the possible values."},"children":[]}]}]}],"example":"CAMPAIGN_NOT_AVAILABLE","enum":["CAMPAIGN_NOT_AVAILABLE","EXCEEDED_10DLC_LIMIT","NUMBER_PROVISIONING_FAILED","PARTNER_SERVICE_UNAVAILABLE","CAMPAIGN_PENDING_ACCEPTANCE","MNO_SHARING_ERROR","CAMPAIGN_PROVISIONING_FAILED","CAMPAIGN_EXPIRED","CAMPAIGN_MNO_REJECTED","CAMPAIGN_MNO_SUSPENDED","CAMPAIGN_MNO_REVIEW","INSUFFICIENT_BALANCE","MOCK_CAMPAIGN_NOT_ALLOWED","TFN_NOT_ALLOWED","INVALID_NNID"],"x-enumDescriptions":{"CAMPAIGN_NOT_AVAILABLE":"The specified campaign is not available.","EXCEEDED_10DLC_LIMIT":"Exceeded the limit for 10DLC.","NUMBER_PROVISIONING_FAILED":"Provisioning the number failed.","PARTNER_SERVICE_UNAVAILABLE":"The third party service is unavailable.","CAMPAIGN_PENDING_ACCEPTANCE":"The campaign is not yet accepted.","MNO_SHARING_ERROR":"Error with MNO.","CAMPAIGN_PROVISIONING_FAILED":"The campaign failed to provision.","CAMPAIGN_EXPIRED":"The campaign expired.","CAMPAIGN_MNO_REJECTED":"The campaign MNO was rejected.","CAMPAIGN_MNO_SUSPENDED":"The campaign MNO was suspended.","CAMPAIGN_MNO_REVIEW":"The campaign MNO is under review.","INSUFFICIENT_BALANCE":"Not enough credit in the account.","MOCK_CAMPAIGN_NOT_ALLOWED":"Provisioning not allowed for mock campaigns.","TFN_NOT_ALLOWED":"Toll free numbers not allowed.","INVALID_NNID":"Invalid NNID."}},"internalFailureCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the status is FAILED, certain processes (eg. number to campaign provisioning) will have an internalFailureCode in the payload. The details of these codes can be found in our dedicated "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/error-codes/provisioning-errors"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provisioning errors"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" documentation."},"children":[]}]}]}],"example":"CRS0018"},"resourceId":{"type":"string","description":"The unique identifier of the resource, depending on the resource type. For example, a phone number.","example":"+12345612345"}}}},"components/schemas/CallbackPayloadNumberOrder":{"id":"components/schemas/CallbackPayloadNumberOrder","kind":"json-schema","title":"CallbackPayloadNumberOrder","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/CallbackPayloadCommon"}],"properties":{"eventType":{"type":"string","description":"The type of the event.","enum":["NUMBER_ORDER_PROCESSING"],"x-enumDescriptions":{"NUMBER_ORDER_PROCESSING":"An event that occurs when a Number Order transitions to a new state."},"example":"NUMBER_ORDER_PROCESSING"},"status":{"type":"string","description":"The status of the event or the state transition it represents.","x-enumDescriptions":{"IN_REVIEW":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Number Order transitioned to the IN_REVIEW state."},"children":[]}]}]}],"BLOCKED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Number Order transitioned to the BLOCKED state. The number order was blocked. To view any reasons associated with the BLOCKED status, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/numbers/number-order/getnumberorderregistration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"get number order registration operation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"COMPLETED":"The Number Order transitioned to the COMPLETED state. This is a final state and indicates the number order was successful.","REJECTED":"The Number Order transitioned to the REJECTED state. This is a final state and indicates the number order was rejected.","EXPIRED":"The Number Order transitioned to the EXPIRED state. This is a final state and indicates the number order expired."},"enum":["IN_REVIEW","BLOCKED","COMPLETED","REJECTED","EXPIRED"],"example":"IN_REVIEW"},"resourceId":{"type":"string","description":"The unique identifier of the resource, depending on the resource type. For example, a number order ID.","example":"01jgkbb8xywmz3hhahd76menqf"}}}},"components/schemas/CallbackPayloadCommon":{"id":"components/schemas/CallbackPayloadCommon","kind":"json-schema","title":"CallbackPayloadCommon","data":{"type":"object","required":["resourceType"],"properties":{"eventId":{"type":"string","description":"The ID of the event.","example":"abcd1234efghijklmnop567890"},"timestamp":{"type":"string","description":"The date and time when the callback was created and added to the callbacks queue.","example":"2023-06-06T07:45:27.785357"},"projectId":{"type":"string","description":"The ID of the project to which the event belongs.","example":"abcd12ef-ab12-ab12-bc34-abcdef123456"},"resourceType":{"$ref":"#/components/schemas/ResourceType"}}}},"components/schemas/InvalidArgument":{"id":"components/schemas/InvalidArgument","kind":"json-schema","title":"InvalidArgument","data":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","enum":[400],"x-enumDescriptions":{"400":"The HTTP status code for invalid arguments."}},"message":{"type":"string"},"status":{"type":"string","enum":["INVALID_ARGUMENT"],"x-enumDescriptions":{"INVALID_ARGUMENT":"The request contained invalid arguments."}},"details":{"type":"array","items":{"$ref":"#/components/schemas/BadRequest"}}}}}}},"components/schemas/BadRequest":{"id":"components/schemas/BadRequest","kind":"json-schema","title":"BadRequest","data":{"type":"object","properties":{"type":{"type":"string","enum":["BadRequest"],"x-enumDescriptions":{"BadRequest":"The request was malformed in some way."}},"fieldViolations":{"type":"array","items":{"$ref":"#/components/schemas/FieldViolation"}}}}},"components/schemas/FieldViolation":{"id":"components/schemas/FieldViolation","kind":"json-schema","title":"FieldViolation","data":{"type":"object","properties":{"field":{"type":"string"},"description":{"type":"string"}}}},"components/schemas/NotFoundErrorDetails":{"id":"components/schemas/NotFoundErrorDetails","kind":"json-schema","title":"NotFoundErrorDetails","data":{"type":"object","properties":{"type":{"type":"string"},"resourceType":{"type":"string","description":"The type of the resource that was not found."},"resourceName":{"type":"string","description":"The name of the resource that was not found."},"owner":{"type":"string","description":"The owner of the resource that was not found."},"description":{"type":"string","description":"A description of the error."}}}},"components/schemas/RequestEntityTooLargeErrorDetails":{"id":"components/schemas/RequestEntityTooLargeErrorDetails","kind":"json-schema","title":"RequestEntityTooLargeErrorDetails","data":{"type":"object","properties":{"type":{"type":"string"},"resourceName":{"type":"string","description":"The name of the resource that exceeded the expected size limit."},"description":{"type":"string","description":"A description of the error."}}}},"components/schemas/NotFound":{"id":"components/schemas/NotFound","kind":"json-schema","title":"NotFound","data":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","enum":[404],"x-enumDescriptions":{"404":"The HTTP status code for a resource not found."}},"message":{"type":"string"},"status":{"type":"string","enum":["NOT_FOUND"],"x-enumDescriptions":{"NOT_FOUND":"The request resource could not be found."}},"details":{"type":"array","items":{"$ref":"#/components/schemas/NotFoundErrorDetails"}}}}}}},"components/schemas/RequestEntityTooLarge":{"id":"components/schemas/RequestEntityTooLarge","kind":"json-schema","title":"RequestEntityTooLarge","data":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","enum":[413],"x-enumDescriptions":{"413":"The HTTP status code for entity too large."}},"message":{"type":"string"},"status":{"type":"string","enum":["CONTENT_TOO_LARGE"],"x-enumDescriptions":{"CONTENT_TOO_LARGE":"The request content is too large."}},"details":{"type":"array","items":{"$ref":"#/components/schemas/RequestEntityTooLargeErrorDetails"}}}}}}},"components/schemas/InternalError":{"id":"components/schemas/InternalError","kind":"json-schema","title":"InternalError","data":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","enum":[500],"x-enumDescriptions":{"500":"The HTTP status code for an internal server error."}},"message":{"type":"string"},"status":{"type":"string","enum":["INTERNAL","UNKNOWN"],"x-enumDescriptions":{"INTERNAL":"An internal server error.","UNKNOWN":"Some unknown error."}},"details":{"type":"array","items":{"type":"object"}}}}}}},"components/schemas/EmergencyAddress":{"id":"components/schemas/EmergencyAddress","kind":"json-schema","title":"Emergency Address","data":{"type":"object","description":"Details of the emergency address.","title":"Emergency Address","properties":{"streetNumber":{"type":"string","description":"The street number for the emergency address.","example":"12345"},"streetInfo":{"type":"string","description":"The street name of the emergency location.","example":"Main St"},"location":{"type":"string","description":"The location for address.","example":"Apt 5"},"city":{"type":"string","description":"The city of the emergency location.","example":"Springfield"},"state":{"type":"string","description":"The state or province of the emergency location.","example":"IL"},"postalCode":{"type":"string","description":"The postal code of the emergency location.","example":"62701"},"postalCodePlusFour":{"type":"string","description":"The postal code of the emergency location.","example":"1234"}}}},"components/schemas/ValidateAddressResponse":{"id":"components/schemas/ValidateAddressResponse","kind":"json-schema","title":"Validate Emergency Address Response","data":{"type":"object","description":"Response object containing details of the emergency address.","title":"Validate Emergency Address Response","properties":{"phoneNumber":{"$ref":"#/components/schemas/PhoneNumber"},"displayName":{"type":"string","description":"User supplied name for the phone number.","example":"User Name"},"validatedAddress":{"$ref":"#/components/schemas/EmergencyAddress"},"validationResult":{"$ref":"#/components/schemas/AddressValidationResultCode"},"validationMessage":{"type":"string","description":"Validation result message","example":"Corrected to valid address"},"correctedAddress":{"$ref":"#/components/schemas/EmergencyAddress"},"candidateAddresses":{"type":"array","items":{"$ref":"#/components/schemas/EmergencyAddress"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of candidate addresses (only available if validationResult == NO_MATCH)"},"children":[]}]}]}]}}}},"components/schemas/EmergencyAddressRequest":{"id":"components/schemas/EmergencyAddressRequest","kind":"json-schema","title":"Emergency Address Request","data":{"type":"object","description":"Request for emergency address.","title":"Emergency Address Request","required":["displayName","address"],"properties":{"displayName":{"type":"string","description":"Name for emergency address.","example":"New emergency address"},"address":{"required":["streetNumber","streetInfo","city","state","postalCode"],"allOf":[{"$ref":"#/components/schemas/EmergencyAddress"}]}}}},"components/schemas/AddressValidationResultCode":{"id":"components/schemas/AddressValidationResultCode","kind":"json-schema","title":"AddressValidationResultCode","data":{"type":"string","enum":["ADDRESS_VALIDATION_RESULT_CODE_UNSPECIFIED","EXACT_MATCH","NEAR_MATCH","NO_MATCH"],"description":"Enum representing the result of address validation.","x-enumDescriptions":{"ADDRESS_VALIDATION_RESULT_CODE_UNSPECIFIED":"Undetermined Result","EXACT_MATCH":"The address is perfect as sent","NEAR_MATCH":"The result was a close enough match and has been corrected","NO_MATCH":"The result is not close enough"}}},"components/schemas/ResourceType":{"id":"components/schemas/ResourceType","kind":"json-schema","title":"ResourceType","data":{"type":"string","description":"The type of the resource.","x-enumDescriptions":{"ACTIVE_NUMBER":"Numbers which are already active and updated with new campaign IDs or service plan IDs.","NUMBER_ORDER":"Number orders created for buying one or more phone numbers."},"example":"ACTIVE_NUMBER","enum":["ACTIVE_NUMBER","NUMBER_ORDER"]}},"schema_690":{"kind":"json-schema","data":{"type":"string","example":"YOUR_projectId"},"id":"schema_690"},"schema_691":{"kind":"json-schema","data":{"type":"string","example":"%2B120"},"id":"schema_691"},"schema_692":{"kind":"json-schema","data":{"$ref":"#/components/schemas/NumberPatternSearchPattern"},"id":"schema_692"},"schema_693":{"kind":"json-schema","data":{"type":"string","example":"US"},"id":"schema_693"},"schema_694":{"kind":"json-schema","data":{"$ref":"#/components/schemas/NumberType"},"id":"schema_694"},"schema_695":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/NumberCapability"}},"id":"schema_695"},"schema_696":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_696"},"schema_697":{"kind":"json-schema","data":{},"id":"schema_697"},"schema_698":{"kind":"json-schema","data":{"type":"string","example":"+12025550134","default":"YOUR_selected_phoneNumber_from_search"},"id":"schema_698"},"schema_699":{"kind":"json-schema","data":{"type":"string"},"id":"schema_699"},"schema_700":{"kind":"json-schema","data":{"type":"string","example":"d1c7ccbf-919d-462f-8587-dec95a1b11zz"},"id":"schema_700"},"schema_701":{"kind":"json-schema","data":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary","description":"File attachment to upload"},"documentType":{"type":"string","description":"Optional document type associated with the uploaded attachment"}}},"id":"schema_701"},"schema_702":{"kind":"json-schema","data":{"type":"string","enum":["phoneNumber","displayName"],"x-enumDescriptions":{"phoneNumber":"Ordered by phone number","displayName":"Ordered by display name"},"description":"The ordering the request is supporting"},"id":"schema_702"},"schema_703":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/NumberType"}},"id":"schema_703"}},"exampleStore":{"components/examples/SearchActivateSMSNumber":{"id":"components/examples/SearchActivateSMSNumber","value":{"regionCode":"US","type":"LOCAL","capabilities":["SMS"],"numberPattern":{"pattern":"+1208","searchPattern":"START"},"smsConfiguration":{"servicePlanId":"YOUR_SMS_servicePlanId","campaignId":"YOUR_campaignId_from_TCR"},"callbackUrl":"https://www.your-callback-server.com/callback"},"summary":"Search and activate a number that matches criteria and sets the SMS configuration"},"components/examples/lookupAuKycRequirementsReq":{"id":"components/examples/lookupAuKycRequirementsReq","value":{"regionCode":"AU","numberType":"MOBILE"}},"components/examples/lookupAuKycRequirementsRes":{"id":"components/examples/lookupAuKycRequirementsRes","value":{"fields":{"schema":"/schema/policySchema-v1.json","rules":[{"template":{}},{"template":{}}],"attachments":[]}}},"components/examples/activateSMSNumberReq":{"id":"components/examples/activateSMSNumberReq","value":{"smsConfiguration":{"servicePlanId":"YOUR_SMS_servicePlanId","campaignId":"YOUR_campaignId_from_TCR"},"callbackUrl":"https://www.your-callback-server.com/callback"},"summary":"Activate number with SMS configuration"},"components/examples/activateSMSNumberRes":{"id":"components/examples/activateSMSNumberRes","value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"MOBILE","capability":["SMS"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","smsConfiguration":{"servicePlanId":"YOUR_service_plan_id","scheduledProvisioning":{"servicePlanId":"YOUR_service_plan_id","status":"WAITING","lastUpdatedTime":"2024-08-04T14:15:22Z","campaignId":"YOUR_campaign_id"},"campaignId":"YOUR_campaign_id"}},"summary":"Response for activing a number with SMS configuration"},"components/examples/activateBothSMSandVoiceNumberReq":{"id":"components/examples/activateBothSMSandVoiceNumberReq","value":{"smsConfiguration":{"servicePlanId":"YOUR_SMS_servicePlanId"},"voiceConfiguration":{"type":"RTC","appId":"YOUR_Voice_appId"},"callbackUrl":"https://www.your-callback-server.com/callback"},"summary":"Activate number with SMS and Voice configuration"},"components/examples/activateBothSMSandVoiceNumberRes":{"id":"components/examples/activateBothSMSandVoiceNumberRes","value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"MOBILE","capability":["SMS","VOICE"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","smsConfiguration":{"servicePlanId":"YOUR_service_plan_id","scheduledProvisioning":{"servicePlanId":"","status":"WAITING","lastUpdatedTime":"2024-08-04T14:15:22Z","campaignId":"YOUR_campaign_id"},"campaignId":"YOUR_campaign_id"},"voiceConfiguration":{"type":"RTC","lastUpdatedTime":"2024-09-24T14:15:22Z","scheduledVoiceProvisioning":{"type":"RTC","lastUpdatedTime":"2024-09-24T14:15:22Z","status":"WAITING","appId":"YOUR_app_id"},"appId":"YOUR_app_id"}},"summary":"Response for activing a number with both SMS and Voice configuration"},"components/examples/activateVoiceNumberReq":{"id":"components/examples/activateVoiceNumberReq","value":{"voiceConfiguration":{"type":"RTC","appId":"YOUR_app_id"},"callbackUrl":"https://www.your-callback-server.com/callback"},"summary":"Activate number with Voice configuration"},"components/examples/activateVoiceNumberRes":{"id":"components/examples/activateVoiceNumberRes","value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"MOBILE","capability":["VOICE"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","voiceConfiguration":{"type":"RTC","lastUpdatedTime":"2024-09-24T14:15:22Z","scheduledVoiceProvisioning":{"type":"RTC","lastUpdatedTime":"2024-09-24T14:15:22Z","status":"WAITING","appId":"YOUR_app_id"},"appId":"YOUR_app_id"}},"summary":"Response for activing a number with Voice configuration"},"components/examples/activateESTNumberReq":{"id":"components/examples/activateESTNumberReq","value":{"voiceConfiguration":{"type":"EST","trunkId":"YOUR_trunk_id"},"callbackUrl":"https://www.your-callback-server.com/callback"},"summary":"Activate number with Elastic SIP Trunking configuration"},"components/examples/activateESTNumberRes":{"id":"components/examples/activateESTNumberRes","value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"LOCAL","capability":["VOICE"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","voiceConfiguration":{"type":"EST","lastUpdatedTime":"2024-09-24T14:15:22Z","scheduledVoiceProvisioning":{"type":"EST","lastUpdatedTime":"2024-09-24T14:15:22Z","status":"WAITING","trunkId":"YOUR_trunk_id"},"trunkId":"YOUR_trunk_id"}},"summary":"Response for activing a number with Elastic SIP Trunking configuration"},"components/examples/activateFaxNumberReq":{"id":"components/examples/activateFaxNumberReq","value":{"voiceConfiguration":{"type":"FAX","serviceId":"YOUR_service_id"},"callbackUrl":"https://www.your-callback-server.com/callback"},"summary":"Activate number with Fax configuration"},"components/examples/activateFaxNumberRes":{"id":"components/examples/activateFaxNumberRes","value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"LOCAL","capability":["VOICE"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","voiceConfiguration":{"type":"FAX","lastUpdatedTime":"2024-09-24T14:15:22Z","scheduledVoiceProvisioning":{"type":"FAX","lastUpdatedTime":"2024-09-24T14:15:22Z","status":"WAITING","serviceId":"YOUR_service_id"},"serviceId":"YOUR_service_id"}},"summary":"Response for activing a number with Fax configuration"},"components/examples/updateSMSandVoiceNumber":{"id":"components/examples/updateSMSandVoiceNumber","value":{"displayName":"MyPhoneNumber","smsConfiguration":{"servicePlanId":"string","campaignId":"YOUR_campaignId_from_TCR"},"voiceConfiguration":{"type":"RTC","appId":"YOUR_Voice_appId"},"callbackUrl":"https://www.your-callback-server.com/callback"},"summary":"Update number with SMS and Voice configuration"},"components/examples/updateSMSNumber":{"id":"components/examples/updateSMSNumber","value":{"displayName":"MyPhoneNumber","smsConfiguration":{"servicePlanId":"YOUR_servicePlanId","campaignId":"YOUR_campaignId_from_TCR"},"callbackUrl":"https://www.your-callback-server.com/callback"},"summary":"Update number with SMS configuration"},"components/examples/updateVoiceNumber":{"id":"components/examples/updateVoiceNumber","value":{"displayName":"MyPhoneNumber","voiceConfiguration":{"type":"RTC","appId":"YOUR_Voice_appId"},"callbackUrl":"https://www.your-callback-server.com/callback"},"summary":"Update number with Voice configuration"},"components/examples/perfectMatch":{"id":"components/examples/perfectMatch","value":{"phoneNumber":"+12025550134","displayName":"User Name","validatedAddress":{"streetNumber":"12345","streetInfo":"Main St","location":"Apt 5","city":"Springfield","state":"IL","postalCode":"62701","postalCodePlusFour":"1234"},"validationResult":"EXACT_MATCH","validationMessage":"Address is a perfect match","correctedAddress":{},"candidateAddresses":[]},"summary":"Address validation is a perfect match"},"components/examples/nearMatch":{"id":"components/examples/nearMatch","value":{"phoneNumber":"+12025550134","displayName":"User Name","validatedAddress":{"streetNumber":"12345","streetInfo":"Main Street","location":"Apt 5","city":"Springfield","state":"IL","postalCode":"62701","postalCodePlusFour":"1234"},"validationResult":"NEAR_MATCH","validationMessage":"Address is a near match","correctedAddress":{"streetNumber":"12345","streetInfo":"Main St","location":"Apt 5","city":"Springfield","state":"IL","postalCode":"62701","postalCodePlusFour":"1234"},"candidateAddresses":[]},"summary":"Address validation is a near match to another known address"},"components/examples/noMatch":{"id":"components/examples/noMatch","value":{"phoneNumber":"+12025550134","displayName":"User Name","validatedAddress":{"streetNumber":"12345","streetInfo":"Main St","location":"Apt 5","city":"Springfield","state":"IL","postalCode":"62701","postalCodePlusFour":"1234"},"validationResult":"NO_MATCH","validationMessage":"Address doesn't match any known address","correctedAddress":{},"candidateAddresses":[{"streetNumber":"67890","streetInfo":"Elm St","location":"Apt 10","city":"Springfield","state":"IL","postalCode":"62702","postalCodePlusFour":"5678"},{"streetNumber":"54321","streetInfo":"Oak St","location":"Apt 20","city":"Springfield","state":"IL","postalCode":"62703","postalCodePlusFour":"9876"}]},"summary":"Address validation doesn't match any known address"},"components/examples/createAustralianNumberOrderRequest":{"id":"components/examples/createAustralianNumberOrderRequest","value":{"regionCode":"AU","numberType":"MOBILE","smsConfiguration":{"servicePlanId":"1dez6a8300774283a4256aa756a11111"},"callbackUrl":"https://www.your-callback-server.com/callback","numberOrderOption":{"phoneNumbers":["+61411111112"]}},"summary":"Create Australian Number Order request"},"components/examples/createUsQuantityOrderRequest":{"id":"components/examples/createUsQuantityOrderRequest","value":{"regionCode":"US","numberType":"LOCAL","smsConfiguration":{"servicePlanId":"1dez6a8300774283a4256aa756a11111"},"callbackUrl":"https://www.your-callback-server.com/callback","quantityOrderOption":{"requestedQuantity":3,"sequential":false}},"summary":"Create US LOCAL Quantity Order request"},"components/examples/australianNumberOrder":{"id":"components/examples/australianNumberOrder","value":{"projectId":"10d64985-0bfb-43d3-a2b9-bc5fa6a4752c","idNumberOrder":"03kjzencnckxrn216rr1zzzzzz","regionCode":"AU","state":"CREATED","numberType":"MOBILE","orderNumbers":[{"phoneNumber":"+61411111112","numberPrice":{"setupPrice":{"currencyCode":"USD","amount":"1.00"},"monthlyPrice":{"currencyCode":"USD","amount":"1.00"},"paymentIntervalMonths":1},"capabilities":["SMS"]}],"smsConfiguration":{"servicePlanId":"1dez6a8300774283a4256aa756a11111"},"expireTime":"2026-03-07T16:53:00.204187Z","createTime":"2026-03-05T16:53:00Z","updateTime":"2026-03-05T16:53:00Z"},"summary":"Australian Number Order response"},"components/examples/australianRegistration":{"id":"components/examples/australianRegistration","value":{"requestDetails":{"data":[[{"senderId":"+61XXXXXXXXX","purposeOfTheTraffic":"One Time Password","intendedUseOfMobileNumbers":"Transactional","iConfirmThatMyBusinessHasAValidUseCaseForThisLn":true}],{"endBusinessName":"ExampleExample","endBusinessAddress":"ExampleExample","endBusinessAddress2":"ExampleExample","city":"Victoria","state":"VIC","country":"AU","postalCode":"3000"},{"firstName":"Example","lastName":"Example","phoneNumber":"+61XXXXXXXXX"}]},"attachments":[{"attachmentId":"01jxn2251d0shhamtbykft2xzx","fileName":"template.rtf","mimeType":"application/rtf","uploadStatus":"WAITING","createTime":"2026-02-24T06:39:55.902553Z","updateTime":"2026-02-24T06:39:55.902553Z"}],"logs":[{"message":"Dear Customer, Please provide a local Australia contact number from 'John Doe'. Thank you. Regards, Sinch Service Implementation Team","createTime":"2026-02-24T06:39:55.902553Z"},{"message":"Dear Customer, We're unable to proceed further with this request as we did not receive any new updates from you. Thank you. Regards, Sinch Service Implementation Team","createTime":"2026-02-25T06:39:55.902553Z"}]},"summary":"Australian registration"},"paths/~1v1~1projects~1{projectId}~1availableNumbers/get/responses/403/content/application~1json/example":{"value":{"error":{"code":403,"message":"","status":"PERMISSION_DENIED","details":[]}},"id":"paths/~1v1~1projects~1{projectId}~1availableNumbers/get/responses/403/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}/get/responses/403/content/application~1json/example":{"value":{"error":{"code":403,"message":"","status":"PERMISSION_DENIED","details":[]}},"id":"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}/get/responses/403/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateBothSMSandVoiceNumber":{"value":{"smsConfiguration":{"servicePlanId":"YOUR_SMS_servicePlanId"},"voiceConfiguration":{"type":"RTC","appId":"YOUR_Voice_appId"},"callbackUrl":"https://www.your-callback-server.com/callback"},"key":"activateBothSMSandVoiceNumber","summary":"Activate number with SMS and Voice configuration","id":"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateBothSMSandVoiceNumber"},"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateSMSNumber":{"value":{"smsConfiguration":{"servicePlanId":"YOUR_SMS_servicePlanId","campaignId":"YOUR_campaignId_from_TCR"},"callbackUrl":"https://www.your-callback-server.com/callback"},"key":"activateSMSNumber","summary":"Activate number with SMS configuration","id":"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateSMSNumber"},"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateVoiceNumber":{"value":{"voiceConfiguration":{"type":"RTC","appId":"YOUR_app_id"},"callbackUrl":"https://www.your-callback-server.com/callback"},"key":"activateVoiceNumber","summary":"Activate number with Voice configuration","id":"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateVoiceNumber"},"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateESTNumber":{"value":{"voiceConfiguration":{"type":"EST","trunkId":"YOUR_trunk_id"},"callbackUrl":"https://www.your-callback-server.com/callback"},"key":"activateESTNumber","summary":"Activate number with Elastic SIP Trunking configuration","id":"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateESTNumber"},"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateFaxNumber":{"value":{"voiceConfiguration":{"type":"FAX","serviceId":"YOUR_service_id"},"callbackUrl":"https://www.your-callback-server.com/callback"},"key":"activateFaxNumber","summary":"Activate number with Fax configuration","id":"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/requestBody/content/application~1json/examples/activateFaxNumber"},"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber":{"value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"MOBILE","capability":["SMS","VOICE"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","smsConfiguration":{"servicePlanId":"YOUR_service_plan_id","scheduledProvisioning":{"servicePlanId":"","status":"WAITING","lastUpdatedTime":"2024-08-04T14:15:22Z","campaignId":"YOUR_campaign_id"},"campaignId":"YOUR_campaign_id"},"voiceConfiguration":{"type":"RTC","lastUpdatedTime":"2024-09-24T14:15:22Z","scheduledVoiceProvisioning":{"type":"RTC","lastUpdatedTime":"2024-09-24T14:15:22Z","status":"WAITING","appId":"YOUR_app_id"},"appId":"YOUR_app_id"}},"key":"activateBothSMSandVoiceNumber","summary":"Response for activing a number with both SMS and Voice configuration","id":"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber"},"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateSMSNumber":{"value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"MOBILE","capability":["SMS"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","smsConfiguration":{"servicePlanId":"YOUR_service_plan_id","scheduledProvisioning":{"servicePlanId":"YOUR_service_plan_id","status":"WAITING","lastUpdatedTime":"2024-08-04T14:15:22Z","campaignId":"YOUR_campaign_id"},"campaignId":"YOUR_campaign_id"}},"key":"activateSMSNumber","summary":"Response for activing a number with SMS configuration","id":"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateSMSNumber"},"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateVoiceNumber":{"value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"MOBILE","capability":["VOICE"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","voiceConfiguration":{"type":"RTC","lastUpdatedTime":"2024-09-24T14:15:22Z","scheduledVoiceProvisioning":{"type":"RTC","lastUpdatedTime":"2024-09-24T14:15:22Z","status":"WAITING","appId":"YOUR_app_id"},"appId":"YOUR_app_id"}},"key":"activateVoiceNumber","summary":"Response for activing a number with Voice configuration","id":"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateVoiceNumber"},"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateESTNumber":{"value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"LOCAL","capability":["VOICE"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","voiceConfiguration":{"type":"EST","lastUpdatedTime":"2024-09-24T14:15:22Z","scheduledVoiceProvisioning":{"type":"EST","lastUpdatedTime":"2024-09-24T14:15:22Z","status":"WAITING","trunkId":"YOUR_trunk_id"},"trunkId":"YOUR_trunk_id"}},"key":"activateESTNumber","summary":"Response for activing a number with Elastic SIP Trunking configuration","id":"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateESTNumber"},"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateFaxNumber":{"value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"LOCAL","capability":["VOICE"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","voiceConfiguration":{"type":"FAX","lastUpdatedTime":"2024-09-24T14:15:22Z","scheduledVoiceProvisioning":{"type":"FAX","lastUpdatedTime":"2024-09-24T14:15:22Z","status":"WAITING","serviceId":"YOUR_service_id"},"serviceId":"YOUR_service_id"}},"key":"activateFaxNumber","summary":"Response for activing a number with Fax configuration","id":"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/200/content/application~1json/examples/activateFaxNumber"},"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/403/content/application~1json/example":{"value":{"error":{"code":403,"message":"","status":"PERMISSION_DENIED","details":[]}},"id":"paths/~1v1~1projects~1{projectId}~1availableNumbers~1{phoneNumber}:rent/post/responses/403/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1availableNumbers:rentAny/post/requestBody/content/application~1json/examples/activateSMSNumber":{"value":{"regionCode":"US","type":"LOCAL","capabilities":["SMS"],"numberPattern":{"pattern":"+1208","searchPattern":"START"},"smsConfiguration":{"servicePlanId":"YOUR_SMS_servicePlanId","campaignId":"YOUR_campaignId_from_TCR"},"callbackUrl":"https://www.your-callback-server.com/callback"},"key":"activateSMSNumber","summary":"Search and activate a number that matches criteria and sets the SMS configuration","id":"paths/~1v1~1projects~1{projectId}~1availableNumbers:rentAny/post/requestBody/content/application~1json/examples/activateSMSNumber"},"paths/~1v1~1projects~1{projectId}~1availableNumbers:rentAny/post/responses/403/content/application~1json/example":{"value":{"error":{"code":403,"message":"","status":"PERMISSION_DENIED","details":[]}},"id":"paths/~1v1~1projects~1{projectId}~1availableNumbers:rentAny/post/responses/403/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1numberOrders:lookupNumberRequirements/post/requestBody/content/application~1json/examples/LookupAustralianKycRequirementsRequest":{"value":{"regionCode":"AU","numberType":"MOBILE"},"key":"LookupAustralianKycRequirementsRequest","summary":"LookupAustralianKycRequirementsRequest","id":"paths/~1v1~1projects~1{projectId}~1numberOrders:lookupNumberRequirements/post/requestBody/content/application~1json/examples/LookupAustralianKycRequirementsRequest"},"paths/~1v1~1projects~1{projectId}~1numberOrders:lookupNumberRequirements/post/responses/200/content/application~1json/examples/LookupAustralianKycRequirementsResponse":{"value":{"fields":{"schema":"/schema/policySchema-v1.json","rules":[{"template":{}},{"template":{}}],"attachments":[]}},"key":"LookupAustralianKycRequirementsResponse","summary":"LookupAustralianKycRequirementsResponse","id":"paths/~1v1~1projects~1{projectId}~1numberOrders:lookupNumberRequirements/post/responses/200/content/application~1json/examples/LookupAustralianKycRequirementsResponse"},"paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/requestBody/content/application~1json/examples/CreateAustralianNumberOrderRequest":{"value":{"regionCode":"AU","numberType":"MOBILE","smsConfiguration":{"servicePlanId":"1dez6a8300774283a4256aa756a11111"},"callbackUrl":"https://www.your-callback-server.com/callback","numberOrderOption":{"phoneNumbers":["+61411111112"]}},"key":"CreateAustralianNumberOrderRequest","summary":"Create Australian Number Order request","id":"paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/requestBody/content/application~1json/examples/CreateAustralianNumberOrderRequest"},"paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/requestBody/content/application~1json/examples/CreateUsQuantityOrderRequest":{"value":{"regionCode":"US","numberType":"LOCAL","smsConfiguration":{"servicePlanId":"1dez6a8300774283a4256aa756a11111"},"callbackUrl":"https://www.your-callback-server.com/callback","quantityOrderOption":{"requestedQuantity":3,"sequential":false}},"key":"CreateUsQuantityOrderRequest","summary":"Create US LOCAL Quantity Order request","id":"paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/requestBody/content/application~1json/examples/CreateUsQuantityOrderRequest"},"paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/responses/200/content/application~1json/examples/AustralianNumberOrder":{"value":{"projectId":"10d64985-0bfb-43d3-a2b9-bc5fa6a4752c","idNumberOrder":"03kjzencnckxrn216rr1zzzzzz","regionCode":"AU","state":"CREATED","numberType":"MOBILE","orderNumbers":[{"phoneNumber":"+61411111112","numberPrice":{"setupPrice":{"currencyCode":"USD","amount":"1.00"},"monthlyPrice":{"currencyCode":"USD","amount":"1.00"},"paymentIntervalMonths":1},"capabilities":["SMS"]}],"smsConfiguration":{"servicePlanId":"1dez6a8300774283a4256aa756a11111"},"expireTime":"2026-03-07T16:53:00.204187Z","createTime":"2026-03-05T16:53:00Z","updateTime":"2026-03-05T16:53:00Z"},"key":"AustralianNumberOrder","summary":"Australian Number Order response","id":"paths/~1v1~1projects~1{projectId}~1numberOrders:createNumberOrder/post/responses/200/content/application~1json/examples/AustralianNumberOrder"},"paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}/get/responses/200/content/application~1json/examples/AustralianNumberOrder":{"value":{"projectId":"10d64985-0bfb-43d3-a2b9-bc5fa6a4752c","idNumberOrder":"03kjzencnckxrn216rr1zzzzzz","regionCode":"AU","state":"CREATED","numberType":"MOBILE","orderNumbers":[{"phoneNumber":"+61411111112","numberPrice":{"setupPrice":{"currencyCode":"USD","amount":"1.00"},"monthlyPrice":{"currencyCode":"USD","amount":"1.00"},"paymentIntervalMonths":1},"capabilities":["SMS"]}],"smsConfiguration":{"servicePlanId":"1dez6a8300774283a4256aa756a11111"},"expireTime":"2026-03-07T16:53:00.204187Z","createTime":"2026-03-05T16:53:00Z","updateTime":"2026-03-05T16:53:00Z"},"key":"AustralianNumberOrder","summary":"Australian Number Order response","id":"paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}/get/responses/200/content/application~1json/examples/AustralianNumberOrder"},"paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/put/requestBody/content/application~1json/examples/updateAustralianRegistration":{"value":{"requestDetails":{"data":[[{"senderId":"+61XXXXXXXXX","purposeOfTheTraffic":"One Time Password","intendedUseOfMobileNumbers":"Transactional","iConfirmThatMyBusinessHasAValidUseCaseForThisLn":true}],{"endBusinessName":"ExampleExample","endBusinessAddress":"ExampleExample","endBusinessAddress2":"ExampleExample","city":"Victoria","state":"VIC","country":"AU","postalCode":"3000"},{"firstName":"Example","lastName":"Example","phoneNumber":"+61XXXXXXXXX"}]},"attachments":[{"attachmentId":"01jxn2251d0shhamtbykft2xzx","fileName":"template.rtf","mimeType":"application/rtf","uploadStatus":"WAITING","createTime":"2026-02-24T06:39:55.902553Z","updateTime":"2026-02-24T06:39:55.902553Z"}],"logs":[{"message":"Dear Customer, Please provide a local Australia contact number from 'John Doe'. Thank you. Regards, Sinch Service Implementation Team","createTime":"2026-02-24T06:39:55.902553Z"},{"message":"Dear Customer, We're unable to proceed further with this request as we did not receive any new updates from you. Thank you. Regards, Sinch Service Implementation Team","createTime":"2026-02-25T06:39:55.902553Z"}]},"key":"updateAustralianRegistration","summary":"Australian registration","id":"paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/put/requestBody/content/application~1json/examples/updateAustralianRegistration"},"paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/put/responses/200/content/application~1json/examples/australianRegistration":{"value":{"requestDetails":{"data":[[{"senderId":"+61XXXXXXXXX","purposeOfTheTraffic":"One Time Password","intendedUseOfMobileNumbers":"Transactional","iConfirmThatMyBusinessHasAValidUseCaseForThisLn":true}],{"endBusinessName":"ExampleExample","endBusinessAddress":"ExampleExample","endBusinessAddress2":"ExampleExample","city":"Victoria","state":"VIC","country":"AU","postalCode":"3000"},{"firstName":"Example","lastName":"Example","phoneNumber":"+61XXXXXXXXX"}]},"attachments":[{"attachmentId":"01jxn2251d0shhamtbykft2xzx","fileName":"template.rtf","mimeType":"application/rtf","uploadStatus":"WAITING","createTime":"2026-02-24T06:39:55.902553Z","updateTime":"2026-02-24T06:39:55.902553Z"}],"logs":[{"message":"Dear Customer, Please provide a local Australia contact number from 'John Doe'. Thank you. Regards, Sinch Service Implementation Team","createTime":"2026-02-24T06:39:55.902553Z"},{"message":"Dear Customer, We're unable to proceed further with this request as we did not receive any new updates from you. Thank you. Regards, Sinch Service Implementation Team","createTime":"2026-02-25T06:39:55.902553Z"}]},"key":"australianRegistration","summary":"Australian registration","id":"paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/put/responses/200/content/application~1json/examples/australianRegistration"},"paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/get/responses/200/content/application~1json/examples/australianRegistration":{"value":{"requestDetails":{"data":[[{"senderId":"+61XXXXXXXXX","purposeOfTheTraffic":"One Time Password","intendedUseOfMobileNumbers":"Transactional","iConfirmThatMyBusinessHasAValidUseCaseForThisLn":true}],{"endBusinessName":"ExampleExample","endBusinessAddress":"ExampleExample","endBusinessAddress2":"ExampleExample","city":"Victoria","state":"VIC","country":"AU","postalCode":"3000"},{"firstName":"Example","lastName":"Example","phoneNumber":"+61XXXXXXXXX"}]},"attachments":[{"attachmentId":"01jxn2251d0shhamtbykft2xzx","fileName":"template.rtf","mimeType":"application/rtf","uploadStatus":"WAITING","createTime":"2026-02-24T06:39:55.902553Z","updateTime":"2026-02-24T06:39:55.902553Z"}],"logs":[{"message":"Dear Customer, Please provide a local Australia contact number from 'John Doe'. Thank you. Regards, Sinch Service Implementation Team","createTime":"2026-02-24T06:39:55.902553Z"},{"message":"Dear Customer, We're unable to proceed further with this request as we did not receive any new updates from you. Thank you. Regards, Sinch Service Implementation Team","createTime":"2026-02-25T06:39:55.902553Z"}]},"key":"australianRegistration","summary":"Australian registration","id":"paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1registration/get/responses/200/content/application~1json/examples/australianRegistration"},"paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1submit/post/responses/200/content/application~1json/examples/AustralianNumberOrder":{"value":{"projectId":"10d64985-0bfb-43d3-a2b9-bc5fa6a4752c","idNumberOrder":"03kjzencnckxrn216rr1zzzzzz","regionCode":"AU","state":"CREATED","numberType":"MOBILE","orderNumbers":[{"phoneNumber":"+61411111112","numberPrice":{"setupPrice":{"currencyCode":"USD","amount":"1.00"},"monthlyPrice":{"currencyCode":"USD","amount":"1.00"},"paymentIntervalMonths":1},"capabilities":["SMS"]}],"smsConfiguration":{"servicePlanId":"1dez6a8300774283a4256aa756a11111"},"expireTime":"2026-03-07T16:53:00.204187Z","createTime":"2026-03-05T16:53:00Z","updateTime":"2026-03-05T16:53:00Z"},"key":"AustralianNumberOrder","summary":"Australian Number Order response","id":"paths/~1v1~1projects~1{projectId}~1numberOrders~1{numberOrderId}~1submit/post/responses/200/content/application~1json/examples/AustralianNumberOrder"},"paths/~1v1~1projects~1{projectId}~1activeNumbers/get/responses/403/content/application~1json/example":{"value":{"error":{"code":403,"message":"","status":"PERMISSION_DENIED","details":[]}},"id":"paths/~1v1~1projects~1{projectId}~1activeNumbers/get/responses/403/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateSMSandVoiceNumber":{"value":{"displayName":"MyPhoneNumber","smsConfiguration":{"servicePlanId":"string","campaignId":"YOUR_campaignId_from_TCR"},"voiceConfiguration":{"type":"RTC","appId":"YOUR_Voice_appId"},"callbackUrl":"https://www.your-callback-server.com/callback"},"key":"updateSMSandVoiceNumber","summary":"Update number with SMS and Voice configuration","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateSMSandVoiceNumber"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateSMSNumber":{"value":{"displayName":"MyPhoneNumber","smsConfiguration":{"servicePlanId":"YOUR_servicePlanId","campaignId":"YOUR_campaignId_from_TCR"},"callbackUrl":"https://www.your-callback-server.com/callback"},"key":"updateSMSNumber","summary":"Update number with SMS configuration","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateSMSNumber"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateVoiceNumber":{"value":{"displayName":"MyPhoneNumber","voiceConfiguration":{"type":"RTC","appId":"YOUR_Voice_appId"},"callbackUrl":"https://www.your-callback-server.com/callback"},"key":"updateVoiceNumber","summary":"Update number with Voice configuration","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/updateVoiceNumber"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber":{"value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"MOBILE","capability":["SMS","VOICE"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","smsConfiguration":{"servicePlanId":"YOUR_service_plan_id","scheduledProvisioning":{"servicePlanId":"","status":"WAITING","lastUpdatedTime":"2024-08-04T14:15:22Z","campaignId":"YOUR_campaign_id"},"campaignId":"YOUR_campaign_id"},"voiceConfiguration":{"type":"RTC","lastUpdatedTime":"2024-09-24T14:15:22Z","scheduledVoiceProvisioning":{"type":"RTC","lastUpdatedTime":"2024-09-24T14:15:22Z","status":"WAITING","appId":"YOUR_app_id"},"appId":"YOUR_app_id"}},"key":"activateBothSMSandVoiceNumber","summary":"Response for activing a number with both SMS and Voice configuration","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateSMSNumber":{"value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"MOBILE","capability":["SMS"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","smsConfiguration":{"servicePlanId":"YOUR_service_plan_id","scheduledProvisioning":{"servicePlanId":"YOUR_service_plan_id","status":"WAITING","lastUpdatedTime":"2024-08-04T14:15:22Z","campaignId":"YOUR_campaign_id"},"campaignId":"YOUR_campaign_id"}},"key":"activateSMSNumber","summary":"Response for activing a number with SMS configuration","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateSMSNumber"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateVoiceNumber":{"value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"MOBILE","capability":["VOICE"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","voiceConfiguration":{"type":"RTC","lastUpdatedTime":"2024-09-24T14:15:22Z","scheduledVoiceProvisioning":{"type":"RTC","lastUpdatedTime":"2024-09-24T14:15:22Z","status":"WAITING","appId":"YOUR_app_id"},"appId":"YOUR_app_id"}},"key":"activateVoiceNumber","summary":"Response for activing a number with Voice configuration","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateVoiceNumber"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateESTNumber":{"value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"LOCAL","capability":["VOICE"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","voiceConfiguration":{"type":"EST","lastUpdatedTime":"2024-09-24T14:15:22Z","scheduledVoiceProvisioning":{"type":"EST","lastUpdatedTime":"2024-09-24T14:15:22Z","status":"WAITING","trunkId":"YOUR_trunk_id"},"trunkId":"YOUR_trunk_id"}},"key":"activateESTNumber","summary":"Response for activing a number with Elastic SIP Trunking configuration","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateESTNumber"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateFaxNumber":{"value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"LOCAL","capability":["VOICE"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","voiceConfiguration":{"type":"FAX","lastUpdatedTime":"2024-09-24T14:15:22Z","scheduledVoiceProvisioning":{"type":"FAX","lastUpdatedTime":"2024-09-24T14:15:22Z","status":"WAITING","serviceId":"YOUR_service_id"},"serviceId":"YOUR_service_id"}},"key":"activateFaxNumber","summary":"Response for activing a number with Fax configuration","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/200/content/application~1json/examples/activateFaxNumber"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/403/content/application~1json/example":{"value":{"error":{"code":403,"message":"","status":"PERMISSION_DENIED","details":[]}},"id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/patch/responses/403/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber":{"value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"MOBILE","capability":["SMS","VOICE"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","smsConfiguration":{"servicePlanId":"YOUR_service_plan_id","scheduledProvisioning":{"servicePlanId":"","status":"WAITING","lastUpdatedTime":"2024-08-04T14:15:22Z","campaignId":"YOUR_campaign_id"},"campaignId":"YOUR_campaign_id"},"voiceConfiguration":{"type":"RTC","lastUpdatedTime":"2024-09-24T14:15:22Z","scheduledVoiceProvisioning":{"type":"RTC","lastUpdatedTime":"2024-09-24T14:15:22Z","status":"WAITING","appId":"YOUR_app_id"},"appId":"YOUR_app_id"}},"key":"activateBothSMSandVoiceNumber","summary":"Response for activing a number with both SMS and Voice configuration","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateSMSNumber":{"value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"MOBILE","capability":["SMS"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","smsConfiguration":{"servicePlanId":"YOUR_service_plan_id","scheduledProvisioning":{"servicePlanId":"YOUR_service_plan_id","status":"WAITING","lastUpdatedTime":"2024-08-04T14:15:22Z","campaignId":"YOUR_campaign_id"},"campaignId":"YOUR_campaign_id"}},"key":"activateSMSNumber","summary":"Response for activing a number with SMS configuration","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateSMSNumber"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateVoiceNumber":{"value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"MOBILE","capability":["VOICE"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","voiceConfiguration":{"type":"RTC","lastUpdatedTime":"2024-09-24T14:15:22Z","scheduledVoiceProvisioning":{"type":"RTC","lastUpdatedTime":"2024-09-24T14:15:22Z","status":"WAITING","appId":"YOUR_app_id"},"appId":"YOUR_app_id"}},"key":"activateVoiceNumber","summary":"Response for activing a number with Voice configuration","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateVoiceNumber"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateESTNumber":{"value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"LOCAL","capability":["VOICE"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","voiceConfiguration":{"type":"EST","lastUpdatedTime":"2024-09-24T14:15:22Z","scheduledVoiceProvisioning":{"type":"EST","lastUpdatedTime":"2024-09-24T14:15:22Z","status":"WAITING","trunkId":"YOUR_trunk_id"},"trunkId":"YOUR_trunk_id"}},"key":"activateESTNumber","summary":"Response for activing a number with Elastic SIP Trunking configuration","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateESTNumber"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateFaxNumber":{"value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"LOCAL","capability":["VOICE"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","voiceConfiguration":{"type":"FAX","lastUpdatedTime":"2024-09-24T14:15:22Z","scheduledVoiceProvisioning":{"type":"FAX","lastUpdatedTime":"2024-09-24T14:15:22Z","status":"WAITING","serviceId":"YOUR_service_id"},"serviceId":"YOUR_service_id"}},"key":"activateFaxNumber","summary":"Response for activing a number with Fax configuration","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}/get/responses/200/content/application~1json/examples/activateFaxNumber"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber":{"value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"MOBILE","capability":["SMS","VOICE"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","smsConfiguration":{"servicePlanId":"YOUR_service_plan_id","scheduledProvisioning":{"servicePlanId":"","status":"WAITING","lastUpdatedTime":"2024-08-04T14:15:22Z","campaignId":"YOUR_campaign_id"},"campaignId":"YOUR_campaign_id"},"voiceConfiguration":{"type":"RTC","lastUpdatedTime":"2024-09-24T14:15:22Z","scheduledVoiceProvisioning":{"type":"RTC","lastUpdatedTime":"2024-09-24T14:15:22Z","status":"WAITING","appId":"YOUR_app_id"},"appId":"YOUR_app_id"}},"key":"activateBothSMSandVoiceNumber","summary":"Response for activing a number with both SMS and Voice configuration","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateBothSMSandVoiceNumber"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateSMSNumber":{"value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"MOBILE","capability":["SMS"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","smsConfiguration":{"servicePlanId":"YOUR_service_plan_id","scheduledProvisioning":{"servicePlanId":"YOUR_service_plan_id","status":"WAITING","lastUpdatedTime":"2024-08-04T14:15:22Z","campaignId":"YOUR_campaign_id"},"campaignId":"YOUR_campaign_id"}},"key":"activateSMSNumber","summary":"Response for activing a number with SMS configuration","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateSMSNumber"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateVoiceNumber":{"value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"MOBILE","capability":["VOICE"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","voiceConfiguration":{"type":"RTC","lastUpdatedTime":"2024-09-24T14:15:22Z","scheduledVoiceProvisioning":{"type":"RTC","lastUpdatedTime":"2024-09-24T14:15:22Z","status":"WAITING","appId":"YOUR_app_id"},"appId":"YOUR_app_id"}},"key":"activateVoiceNumber","summary":"Response for activing a number with Voice configuration","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateVoiceNumber"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateESTNumber":{"value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"LOCAL","capability":["VOICE"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","voiceConfiguration":{"type":"EST","lastUpdatedTime":"2024-09-24T14:15:22Z","scheduledVoiceProvisioning":{"type":"EST","lastUpdatedTime":"2024-09-24T14:15:22Z","status":"WAITING","trunkId":"YOUR_trunk_id"},"trunkId":"YOUR_trunk_id"}},"key":"activateESTNumber","summary":"Response for activing a number with Elastic SIP Trunking configuration","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateESTNumber"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateFaxNumber":{"value":{"phoneNumber":"+12025550134","projectId":"51bc3f40-f266-4ca8-8938-a1ed0ff32b9a","displayName":"MyPhoneNumber","regionCode":"US","type":"LOCAL","capability":["VOICE"],"money":{"currencyCode":"USD","amount":"2.00"},"paymentIntervalMonths":0,"nextChargeDate":"2024-08-24T14:15:22Z","expireAt":"2024-09-24T14:15:22Z","voiceConfiguration":{"type":"FAX","lastUpdatedTime":"2024-09-24T14:15:22Z","scheduledVoiceProvisioning":{"type":"FAX","lastUpdatedTime":"2024-09-24T14:15:22Z","status":"WAITING","serviceId":"YOUR_service_id"},"serviceId":"YOUR_service_id"}},"key":"activateFaxNumber","summary":"Response for activing a number with Fax configuration","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/200/content/application~1json/examples/activateFaxNumber"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/403/content/application~1json/example":{"value":{"error":{"code":403,"message":"","status":"PERMISSION_DENIED","details":[]}},"id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}:release/post/responses/403/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress/get/responses/403/content/application~1json/example":{"value":{"error":{"code":403,"message":"","status":"PERMISSION_DENIED","details":[]}},"id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress/get/responses/403/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:provision/post/requestBody/content/application~1json/example":{"value":{"displayName":"New Emergency Address","address":{"streetNumber":"12345","streetInfo":"Main St","city":"Springfield","state":"IL","postalCode":"62701"}},"id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:provision/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:provision/post/responses/403/content/application~1json/example":{"value":{"error":{"code":403,"message":"","status":"PERMISSION_DENIED","details":[]}},"id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:provision/post/responses/403/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:deprovision/post/responses/403/content/application~1json/example":{"value":{"error":{"code":403,"message":"","status":"PERMISSION_DENIED","details":[]}},"id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:deprovision/post/responses/403/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/requestBody/content/application~1json/example":{"value":{"displayName":"New Emergency Address","address":{"streetNumber":"12345","streetInfo":"Main St","city":"Springfield","state":"IL","postalCode":"62701"}},"id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/requestBody/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/responses/200/content/application~1json/examples/perfectMatch":{"value":{"phoneNumber":"+12025550134","displayName":"User Name","validatedAddress":{"streetNumber":"12345","streetInfo":"Main St","location":"Apt 5","city":"Springfield","state":"IL","postalCode":"62701","postalCodePlusFour":"1234"},"validationResult":"EXACT_MATCH","validationMessage":"Address is a perfect match","correctedAddress":{},"candidateAddresses":[]},"key":"perfectMatch","summary":"Address validation is a perfect match","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/responses/200/content/application~1json/examples/perfectMatch"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/responses/200/content/application~1json/examples/nearMatch":{"value":{"phoneNumber":"+12025550134","displayName":"User Name","validatedAddress":{"streetNumber":"12345","streetInfo":"Main Street","location":"Apt 5","city":"Springfield","state":"IL","postalCode":"62701","postalCodePlusFour":"1234"},"validationResult":"NEAR_MATCH","validationMessage":"Address is a near match","correctedAddress":{"streetNumber":"12345","streetInfo":"Main St","location":"Apt 5","city":"Springfield","state":"IL","postalCode":"62701","postalCodePlusFour":"1234"},"candidateAddresses":[]},"key":"nearMatch","summary":"Address validation is a near match to another known address","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/responses/200/content/application~1json/examples/nearMatch"},"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/responses/200/content/application~1json/examples/noMatch":{"value":{"phoneNumber":"+12025550134","displayName":"User Name","validatedAddress":{"streetNumber":"12345","streetInfo":"Main St","location":"Apt 5","city":"Springfield","state":"IL","postalCode":"62701","postalCodePlusFour":"1234"},"validationResult":"NO_MATCH","validationMessage":"Address doesn't match any known address","correctedAddress":{},"candidateAddresses":[{"streetNumber":"67890","streetInfo":"Elm St","location":"Apt 10","city":"Springfield","state":"IL","postalCode":"62702","postalCodePlusFour":"5678"},{"streetNumber":"54321","streetInfo":"Oak St","location":"Apt 20","city":"Springfield","state":"IL","postalCode":"62703","postalCodePlusFour":"9876"}]},"key":"noMatch","summary":"Address validation doesn't match any known address","id":"paths/~1v1~1projects~1{projectId}~1activeNumbers~1{phoneNumber}~1emergencyAddress:validate/post/responses/200/content/application~1json/examples/noMatch"},"paths/~1v1~1projects~1{projectId}~1availableRegions/get/responses/403/content/application~1json/example":{"value":{"error":{"code":403,"message":"","status":"PERMISSION_DENIED","details":[]}},"id":"paths/~1v1~1projects~1{projectId}~1availableRegions/get/responses/403/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1callbackConfiguration/get/responses/403/content/application~1json/example":{"value":{"error":{"code":403,"message":"","status":"PERMISSION_DENIED","details":[]}},"id":"paths/~1v1~1projects~1{projectId}~1callbackConfiguration/get/responses/403/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1callbackConfiguration/patch/responses/403/content/application~1json/example":{"value":{"error":{"code":403,"message":"","status":"PERMISSION_DENIED","details":[]}},"id":"paths/~1v1~1projects~1{projectId}~1callbackConfiguration/patch/responses/403/content/application~1json/example"}},"securitySchemeStore":{"Basic":{"id":"Basic","type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your key ID and Key secret serve as the username and password, respectively. Both can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sinch Customer Dashboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information about basic authentication in the Numbers API, click "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/basic"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"OAuth2.0":{"id":"OAuth2.0","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username and password are your Key ID and Key Secret from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access keys section"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.sinch.com/oauth2/token","scopes":{}}}}},"servers":[{"url":"https://numbers.api.sinch.com","description":"Global API"}],"specType":"openapi"},"options":{"sortRequiredPropsFirst":true,"mockServer":{"url":"/_mock/docs/numbers/api-reference/numbers","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/numbers/api-reference/numbers.json?download"},{"url":"/_bundle/docs/numbers/api-reference/numbers.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Numbers | Sinch","description":"# Overview\n\nThe Numbers API enables you to search for, buy, view, and manage numbers. It's considered a precursor to other APIs in the Sinch product family. The numbers API can be used in tandem with any of our APIs that perform messaging or calling. Once you have bought your numbers, you can then use the various other APIs, such as [SMS](https://developers.sinch.com/docs/sms/) or [Voice](https://developers.sinch.com/docs/voice/), to assign and use those numbers.\n\n## Choosing how to buy a number\n\nUse the [Number Order](https://developers.sinch.com/docs/numbers/api-reference/numbers/number-order) API to buy numbers. It supports numbers from all regions and of all number types, and it collects any registration (KYC) information and supporting documents a region requires:\n\n1. Check what the region and number type require (\"Lookup number requirements\").\n2. Find a number to buy (\"Search for available phone numbers\" in the [Available Numbers](https://developers.sinch.com/docs/numbers/api-reference/numbers/available-number) API), or skip this step and order by criteria instead.\n3. Create the order, provide any required registration information and documents, and submit it.\n\nFor a step-by-step walkthrough, see [Ordering numbers that meet specific requirements](https://developers.sinch.com/docs/numbers/kyc-numbers-order).\n\n**Deprecated:** The Available Numbers activation endpoints, \"Activate a new phone number\" (`availableNumbers/{phoneNumber}:rent`) and \"Rent any number that matches the criteria\" (`availableNumbers:rentAny`), are deprecated and only support US `LOCAL` numbers. They remain available for existing integrations, but new integrations should use the Number Order API. The Available Numbers search endpoints aren't deprecated and work for all regions and number types.\n\n## Numbers REST formats and conventions\n\nLet's take a brief look at some of the formats used in the REST API.\n\n### JSON\n\nJSON (`application/json`) is the content type of both requests and responses if not otherwise specified.\n\nRequests with invalid JSON will be rejected.\n\n### Null values\n\nNull values can be omitted in requests and will be omitted in responses. In some cases, explicitly setting `null` will overwrite a previously set value with `null`.\n\n### Phone numbers\n\nOnly phone numbers in [E.164](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537) standard format are accepted by the API.\n\n#### Examples:\n\n- **US phone number:** `+13059394139`\n- **UK phone number:** `+447478727259`\n- **SE phone number:** `+46113232516`\n\n## Status codes\n\nA summary of status codes can be found on the [HTTP status codes page](https://developers.sinch.com/docs/numbers/api-reference/error-codes/status-codes).\n\n## IP addresses for callbacks\n\nTo successfully use callbacks with Numbers, add the following IP addresses to your allowlist:\n\n- 54.76.19.159\n- 54.78.194.39\n- 54.155.83.128\n\n## New features\n\nNew features might result in additional request and response parameters. New request parameters will either have a default value or be considered optional to retain backwards compatibility. It's highly recommended to ignore any unexpected parameters when reading JSON in API responses and in callback handlers.\n"}},"baseSlug":"/docs/numbers/api-reference/numbers","routesMapping":{}}