{"items":[{"type":"link","label":"Imported Numbers and Hosting Orders","link":"/docs/numbers/api-reference/imported-hosting","routeSlug":"/docs/numbers/api-reference/imported-hosting","content":{"contentType":"overview","meta":{"name":"Imported Numbers and Hosting Orders"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"imported-hosting.json","url":"/_bundle/docs/numbers/api-reference/imported-hosting.json?download"},{"kind":"download","label":"imported-hosting.yaml","url":"/_bundle/docs/numbers/api-reference/imported-hosting.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://imported.numbers.api.sinch.com","description":"Global API"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Imported Numbers and Hosting Orders (1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"API for importing, hosting, and qualifying numbers to enable them for use with Sinch SMS text messaging services."}],"sectionId":"/docs/numbers/api-reference/imported-hosting"}],"sectionId":"/docs/numbers/api-reference/imported-hosting"}]}]}},{"type":"group","label":"Hosting Orders","link":"/docs/numbers/api-reference/imported-hosting/hosting-orders","routeSlug":"/docs/numbers/api-reference/imported-hosting/hosting-orders","items":[{"label":"List hosting orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/hosting-orders/hostingorderservice_listhostingorders","routeSlug":"/docs/numbers/api-reference/imported-hosting/hosting-orders/hostingorderservice_listhostingorders","metadata":{"seo":{"title":"List hosting orders","description":"Lists the hosting orders for the project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"HostingOrderService_ListHostingOrders","name":"List hosting orders","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List hosting orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists the hosting orders for the 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_675","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}~1hostingOrders/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"regionCode","in":"query","schemaId":"schema_676","description":"Region code to filter by. ISO 3166-1 alpha-2 country code of the phone number. Currently supported are US, CA"},{"name":"states","in":"query","schemaId":"schema_677","description":"The hosting order states","required":true},{"name":"type","in":"query","schemaId":"schema_678","description":"The hosting order type","required":true},{"name":"servicePlanId","in":"query","schemaId":"schema_679","description":"The hosting order servicePlanId","required":true},{"name":"campaignId","in":"query","schemaId":"schema_680","description":"The hosting order campaignId","required":true},{"name":"orderBy","in":"query","schemaId":"schema_681","description":"Parameter used to order the returned hosting orders"},{"name":"pageToken","in":"query","schemaId":"schema_682","description":"The next page token value returned from a previous listing."},{"name":"pageSize","in":"query","schemaId":"schema_683","description":"The maximum number of items to return, server can enforce an upper limit and overwrite the value."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/hostingOrders","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"}],"query":[{"name":"regionCode","in":"query","required":false,"example":"US","schemaId":"schema_676"},{"name":"states","in":"query","required":true,"schemaId":"schema_677"},{"name":"type","in":"query","required":true,"schemaId":"schema_678"},{"name":"servicePlanId","in":"query","required":true,"example":"324e4567-e89b-12d3-a456-426614174000","schemaId":"schema_679"},{"name":"campaignId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_680"},{"name":"orderBy","in":"query","required":false,"schemaId":"schema_681"},{"name":"pageToken","in":"query","required":false,"example":"C2VNYXJrEg4KDCsxMjAxMjI2MzUyOQ==","schemaId":"schema_682"},{"name":"pageSize","in":"query","required":false,"example":20,"schemaId":"schema_683"}],"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}/hostingOrders","href":"hosting-orders/hostingorderservice_listhostingorders","openApiOperationId":"HostingOrderService_ListHostingOrders","summary":"List hosting orders","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.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/ListHostingOrdersResponse"}},"schemaId":"components/schemas/ListHostingOrdersResponse"},{"code":"404","description":"NOT FOUND: The resource could not be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListHostingOrdersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListHostingOrdersResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hosting-orders/hostingorderservice_listhostingorders"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/hostingOrders"},{"label":"Get hosting order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/hosting-orders/hostingorderservice_gethostingorder","routeSlug":"/docs/numbers/api-reference/imported-hosting/hosting-orders/hostingorderservice_gethostingorder","metadata":{"seo":{"title":"Get hosting order","description":"Returns the hosting order specified by the hosting order ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"HostingOrderService_GetHostingOrder","name":"Get hosting order","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get hosting order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the hosting order specified by the hosting order 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_675","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":"hostingOrderId","in":"path","schemaId":"schema_684","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}~1hostingOrders~1{hostingOrderId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/hostingOrders/{hostingOrderId}","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"},{"name":"hostingOrderId","in":"path","required":true,"example":"01arz3ndektsv4rrffq69g5fav","schemaId":"schema_684"}],"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}/hostingOrders/{hostingOrderId}","href":"hosting-orders/hostingorderservice_gethostingorder","openApiOperationId":"HostingOrderService_GetHostingOrder","summary":"Get hosting order","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.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/HostingOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/HostingOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"NOT FOUND: The resource could not be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/HostingOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HostingOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hosting-orders/hostingorderservice_gethostingorder"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/hostingOrders/{hostingOrderId}"},{"label":"Retrieve a hosting order report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/hosting-orders/gethostingorderreport","routeSlug":"/docs/numbers/api-reference/imported-hosting/hosting-orders/gethostingorderreport","metadata":{"seo":{"title":"Retrieve a hosting order report","description":"Returns the report object for a specific hosting order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetHostingOrderReport","name":"Retrieve a hosting order report","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}~1report/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a hosting order report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the report object for a specific hosting order"},{"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_675","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":"hostingOrderId","in":"path","schemaId":"schema_684","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}~1hostingOrders~1{hostingOrderId}~1report/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/hostingOrders/{hostingOrderId}/report","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"},{"name":"hostingOrderId","in":"path","required":true,"example":"01arz3ndektsv4rrffq69g5fav","schemaId":"schema_684"}],"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}/hostingOrders/{hostingOrderId}/report","href":"hosting-orders/gethostingorderreport","openApiOperationId":"GetHostingOrderReport","summary":"Retrieve a hosting order report","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.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 with a hosting order report, or an error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HostingOrderReport","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}~1report/get/responses/200/content/application~1json/examples/hostingOrderReportResponse"]}},"schemaId":"components/schemas/HostingOrderReport","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}~1report/get/responses/200/content/application~1json/examples/hostingOrderReportResponse"]},{"code":"404","description":"The imported number, project, hosting order, qualified number or phone number could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}~1report/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/HostingOrderReport","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}~1report/get/responses/200/content/application~1json/examples/hostingOrderReportResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HostingOrderReport","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}~1report/get/responses/200/content/application~1json/examples/hostingOrderReportResponse"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hosting-orders/gethostingorderreport"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/hostingOrders/{hostingOrderId}/report"},{"label":"List hosting order numbers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/hosting-orders/hostingorderservice_listhostingordernumbers","routeSlug":"/docs/numbers/api-reference/imported-hosting/hosting-orders/hostingorderservice_listhostingordernumbers","metadata":{"seo":{"title":"List hosting order numbers","description":"Lists the numbers belonging to the specified hosting order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"HostingOrderService_ListHostingOrderNumbers","name":"List hosting order numbers","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}~1numbers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List hosting order numbers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists the numbers belonging to the specified hosting order."},{"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_675","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":"hostingOrderId","in":"path","schemaId":"schema_684","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}~1hostingOrders~1{hostingOrderId}~1numbers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"orderBy","in":"query","schemaId":"schema_681","description":"Parameter used to order the returned hosting orders"},{"name":"pageToken","in":"query","schemaId":"schema_682","description":"The next page token value returned from a previous listing."},{"name":"pageSize","in":"query","schemaId":"schema_683","description":"The maximum number of items to return, server can enforce an upper limit and overwrite the value."},{"name":"osrUpdateState","in":"query","schemaId":"schema_685","description":"Filter the results by the state of the OSR update."},{"name":"campaignProvisioningState","in":"query","schemaId":"schema_685","description":"Filter the results by the state of the campaign provisioning."},{"name":"platformProvisioningState","in":"query","schemaId":"schema_685","description":"Filter the results by the state of the platform provisioning."}],"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}~1numbers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/hostingOrders/{hostingOrderId}/numbers","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"},{"name":"hostingOrderId","in":"path","required":true,"example":"01arz3ndektsv4rrffq69g5fav","schemaId":"schema_684"}],"query":[{"name":"orderBy","in":"query","required":false,"schemaId":"schema_681"},{"name":"pageToken","in":"query","required":false,"example":"C2VNYXJrEg4KDCsxMjAxMjI2MzUyOQ==","schemaId":"schema_682"},{"name":"pageSize","in":"query","required":false,"example":20,"schemaId":"schema_683"},{"name":"osrUpdateState","in":"query","required":false,"example":"DONE","schemaId":"components/schemas/State"},{"name":"campaignProvisioningState","in":"query","example":"DONE","schemaId":"components/schemas/State"},{"name":"platformProvisioningState","in":"query","example":"DONE","schemaId":"components/schemas/State"}],"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}/hostingOrders/{hostingOrderId}/numbers","href":"hosting-orders/hostingorderservice_listhostingordernumbers","openApiOperationId":"HostingOrderService_ListHostingOrderNumbers","summary":"List hosting order numbers","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.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/ListHostingOrderNumbersResponse"}},"schemaId":"components/schemas/ListHostingOrderNumbersResponse"},{"code":"404","description":"NOT FOUND: The resource could not be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}~1numbers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListHostingOrderNumbersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListHostingOrderNumbersResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hosting-orders/hostingorderservice_listhostingordernumbers"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/hostingOrders/{hostingOrderId}/numbers"},{"label":"Get hosting order number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/hosting-orders/hostingorderservice_gethostingordernumber","routeSlug":"/docs/numbers/api-reference/imported-hosting/hosting-orders/hostingorderservice_gethostingordernumber","metadata":{"seo":{"title":"Get hosting order number","description":"Returns the specified phone number belonging to the specified hosting order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"HostingOrderService_GetHostingOrderNumber","name":"Get hosting order number","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}~1numbers~1{phoneNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get hosting order number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the specified phone number belonging to the specified hosting order."},{"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_675","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":"hostingOrderId","in":"path","schemaId":"schema_684","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_686","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":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}~1numbers~1{phoneNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/hostingOrders/{hostingOrderId}/numbers/{phoneNumber}","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"},{"name":"hostingOrderId","in":"path","required":true,"example":"01arz3ndektsv4rrffq69g5fav","schemaId":"schema_684"},{"name":"phoneNumber","in":"path","required":true,"example":"+12025550134","schemaId":"schema_686"}],"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}/hostingOrders/{hostingOrderId}/numbers/{phoneNumber}","href":"hosting-orders/hostingorderservice_gethostingordernumber","openApiOperationId":"HostingOrderService_GetHostingOrderNumber","summary":"Get hosting order number","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.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/HostingOrderNumber"}},"schemaId":"components/schemas/HostingOrderNumber"},{"code":"404","description":"NOT FOUND: The resource could not be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}~1numbers~1{phoneNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/HostingOrderNumber","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HostingOrderNumber"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hosting-orders/hostingorderservice_gethostingordernumber"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/hostingOrders/{hostingOrderId}/numbers/{phoneNumber}"},{"label":"Import numbers using hosting orders","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/hosting-orders/hostingorderservice_importnumbers","routeSlug":"/docs/numbers/api-reference/imported-hosting/hosting-orders/hostingorderservice_importnumbers","metadata":{"seo":{"title":"Import numbers using hosting orders","description":"Import numbers associated with hosting orders of a specific project and schedule the async provisioning to Sinch SMS platform and linking to campaign if applicable."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"HostingOrderService_ImportNumbers","name":"Import numbers using hosting orders","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders:importNumbers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import numbers using hosting orders","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":"Import numbers associated with hosting orders of a specific project and schedule the async provisioning to Sinch SMS platform and linking to campaign if applicable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This operation is limited to five numbers. If you want to increase the quantity of numbers you can import using this operation, please contact your account manager for authorization."},"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_675","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}~1hostingOrders:importNumbers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ImportNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:importNumbers/post/requestBody/content/application~1json/examples/importNumbersRequest"]}},"schemaId":"components/schemas/ImportNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:importNumbers/post/requestBody/content/application~1json/examples/importNumbersRequest"],"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders:importNumbers/post/requestBody","description":"The request to import hosting orders numbers in the current project"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/hostingOrders:importNumbers","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"}],"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/ImportNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:importNumbers/post/requestBody/content/application~1json/examples/importNumbersRequest"]}},"responseCodes":["200","500"],"pointer":"/v1/projects/{projectId}/hostingOrders:importNumbers","href":"hosting-orders/hostingorderservice_importnumbers","openApiOperationId":"HostingOrderService_ImportNumbers","summary":"Import numbers using hosting orders","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"schemaId":"components/schemas/ImportNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:importNumbers/post/requestBody/content/application~1json/examples/importNumbersRequest"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ImportNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:importNumbers/post/requestBody/content/application~1json/examples/importNumbersRequest"]}},"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 with a hosting order, or an error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportHostingOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:importNumbers/post/responses/200/content/application~1json/examples/hostingOrderResponse"]}},"schemaId":"components/schemas/ImportHostingOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:importNumbers/post/responses/200/content/application~1json/examples/hostingOrderResponse"]},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders:importNumbers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ImportHostingOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:importNumbers/post/responses/200/content/application~1json/examples/hostingOrderResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportHostingOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:importNumbers/post/responses/200/content/application~1json/examples/hostingOrderResponse"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hosting-orders/hostingorderservice_importnumbers"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/hostingOrders:importNumbers"},{"label":"Text enable numbers in hosting orders","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/hosting-orders/textenablenumbers","routeSlug":"/docs/numbers/api-reference/imported-hosting/hosting-orders/textenablenumbers","metadata":{"seo":{"title":"Text enable numbers in hosting orders","description":"Text enable numbers associated with hosting orders of a specific project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TextEnableNumbers","name":"Text enable numbers in hosting orders","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Text enable numbers in hosting orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Text enable numbers associated with hosting orders of a specific 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_675","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}~1hostingOrders:textEnableNumbers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TextEnableNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers","paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/requestBody/content/application~1json/examples/blanketLoa"]}},"schemaId":"components/schemas/TextEnableNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers","paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/requestBody/content/application~1json/examples/blanketLoa"],"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/requestBody","description":"The request to text-enable hosting orders numbers in the current project"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/hostingOrders:textEnableNumbers","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"}],"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/TextEnableNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers","paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/requestBody/content/application~1json/examples/blanketLoa"]}},"responseCodes":["200","400","404","409","500"],"pointer":"/v1/projects/{projectId}/hostingOrders:textEnableNumbers","href":"hosting-orders/textenablenumbers","openApiOperationId":"TextEnableNumbers","summary":"Text enable numbers in hosting orders","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"schemaId":"components/schemas/TextEnableNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers","paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/requestBody/content/application~1json/examples/blanketLoa"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TextEnableNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers","paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/requestBody/content/application~1json/examples/blanketLoa"]}},"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 with a hosting order, or an error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HostingOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/responses/200/content/application~1json/examples/hostingOrderTextEnableResponse","paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/responses/200/content/application~1json/examples/hostingOrderImportNumbersResponse"]}},"schemaId":"components/schemas/HostingOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/responses/200/content/application~1json/examples/hostingOrderTextEnableResponse","paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/responses/200/content/application~1json/examples/hostingOrderImportNumbersResponse"]},{"code":"400","description":"Status returned if any of the projectId, displayName, regionCode, numbers, nnid, servicePlanId or campaignId parameters are not valid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/responses/400/content/application~1json/examples/invalidServicePlanId"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/responses/400/content/application~1json/examples/invalidServicePlanId"]},{"code":"404","description":"The imported number, project, hosting order, qualified number or phone number could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"409","description":"The imported number already exists and cannot be created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/HostingOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/responses/200/content/application~1json/examples/hostingOrderTextEnableResponse","paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/responses/200/content/application~1json/examples/hostingOrderImportNumbersResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HostingOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/responses/200/content/application~1json/examples/hostingOrderTextEnableResponse","paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/responses/200/content/application~1json/examples/hostingOrderImportNumbersResponse"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/responses/400/content/application~1json/examples/invalidServicePlanId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/responses/400/content/application~1json/examples/invalidServicePlanId"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"409","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hosting-orders/textenablenumbers"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/hostingOrders:textEnableNumbers"},{"label":"Text enable Toll Free numbers in hosting orders","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/hosting-orders/textenabletollfreenumbers","routeSlug":"/docs/numbers/api-reference/imported-hosting/hosting-orders/textenabletollfreenumbers","metadata":{"seo":{"title":"Text enable Toll Free numbers in hosting orders","description":"Text enable Toll Free numbers associated with hosting orders of a specific project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TextEnableTollFreeNumbers","name":"Text enable Toll Free numbers in hosting orders","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Text enable Toll Free numbers in hosting orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Text enable Toll Free numbers associated with hosting orders of a specific 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_675","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}~1hostingOrders:textEnableTollFreeNumbers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TextEnableTollFreeNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers"]}},"schemaId":"components/schemas/TextEnableTollFreeNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers"],"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/requestBody","description":"The request to text-enable hosting orders Toll Free numbers in the current project"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/hostingOrders:textEnableTollFreeNumbers","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"}],"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/TextEnableTollFreeNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers"]}},"responseCodes":["200","400","404","409","500"],"pointer":"/v1/projects/{projectId}/hostingOrders:textEnableTollFreeNumbers","href":"hosting-orders/textenabletollfreenumbers","openApiOperationId":"TextEnableTollFreeNumbers","summary":"Text enable Toll Free numbers in hosting orders","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"schemaId":"components/schemas/TextEnableTollFreeNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TextEnableTollFreeNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers"]}},"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 with a hosting order, or an error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HostingOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderTextEnableResponse","paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderImportNumbersResponse"]}},"schemaId":"components/schemas/HostingOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderTextEnableResponse","paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderImportNumbersResponse"]},{"code":"400","description":"Status returned if any of the projectId, displayName, regionCode, numbers, nnid, servicePlanId or campaignId parameters are not valid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/responses/400/content/application~1json/examples/invalidServicePlanId"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/responses/400/content/application~1json/examples/invalidServicePlanId"]},{"code":"404","description":"The imported number, project, hosting order, qualified number or phone number could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"409","description":"The imported number already exists and cannot be created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/HostingOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderTextEnableResponse","paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderImportNumbersResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HostingOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderTextEnableResponse","paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderImportNumbersResponse"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/responses/400/content/application~1json/examples/invalidServicePlanId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/responses/400/content/application~1json/examples/invalidServicePlanId"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"409","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hosting-orders/textenabletollfreenumbers"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/hostingOrders:textEnableTollFreeNumbers"}],"content":{"contentType":"group","meta":{"name":"Hosting Orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Hosting Orders","showPageActions":true},{"nodeType":"markdoc","content":"Hosted numbers provide you with an easy method to port your SMS enabled numbers to Sinch or to use SMS messaging and other products to send and receive messages, on voice-enabled numbers (including landline numbers) that you already own.\n\nNote: The SMS enablement process is only supported in United States and Canada.\n\nThe Hosting Orders API allows you to manage all the numbers that you are hosting on the Sinch platform. This includes numbers that you have ported to Sinch and/or any non- Sinch numbers that you already own and are hosting on Sinch to enable Sinch SMS messaging and other products."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/hostingOrders","summary":"List hosting orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hosting-orders/hostingorderservice_listhostingorders","deprecated":false},{"title":"/v1/projects/{projectId}/hostingOrders/{hostingOrderId}","summary":"Get hosting order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hosting-orders/hostingorderservice_gethostingorder","deprecated":false},{"title":"/v1/projects/{projectId}/hostingOrders/{hostingOrderId}/report","summary":"Retrieve a hosting order report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hosting-orders/gethostingorderreport","deprecated":false},{"title":"/v1/projects/{projectId}/hostingOrders/{hostingOrderId}/numbers","summary":"List hosting order numbers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hosting-orders/hostingorderservice_listhostingordernumbers","deprecated":false},{"title":"/v1/projects/{projectId}/hostingOrders/{hostingOrderId}/numbers/{phoneNumber}","summary":"Get hosting order number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hosting-orders/hostingorderservice_gethostingordernumber","deprecated":false},{"title":"/v1/projects/{projectId}/hostingOrders:importNumbers","summary":"Import numbers using hosting orders","prefix":{"name":"post","color":"post"},"badges":[],"link":"/hosting-orders/hostingorderservice_importnumbers","deprecated":false},{"title":"/v1/projects/{projectId}/hostingOrders:textEnableNumbers","summary":"Text enable numbers in hosting orders","prefix":{"name":"post","color":"post"},"badges":[],"link":"/hosting-orders/textenablenumbers","deprecated":false},{"title":"/v1/projects/{projectId}/hostingOrders:textEnableTollFreeNumbers","summary":"Text enable Toll Free numbers in hosting orders","prefix":{"name":"post","color":"post"},"badges":[],"link":"/hosting-orders/textenabletollfreenumbers","deprecated":false}]}]}]}]}},{"type":"group","label":"Imported Numbers","link":"/docs/numbers/api-reference/imported-hosting/imported-numbers","routeSlug":"/docs/numbers/api-reference/imported-hosting/imported-numbers","items":[{"label":"List imported numbers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/imported-numbers/importnumberservice_listimportednumbers","routeSlug":"/docs/numbers/api-reference/imported-hosting/imported-numbers/importnumberservice_listimportednumbers","metadata":{"seo":{"title":"List imported numbers","description":"Lists all imported numbers for the project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ImportNumberService_ListImportedNumbers","name":"List imported numbers","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1importedNumbers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List imported numbers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all imported numbers for the 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_675","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}~1importedNumbers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"regionCode","in":"query","schemaId":"schema_676","description":"Region code to filter by. ISO 3166-1 alpha-2 country code of the phone number. Currently supported are US, CA"},{"name":"numberPattern.pattern","in":"query","schemaId":"schema_687","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."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"START"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a plus sign (+) must be included and URL encoded. For example, to search for area code 206 in the US, the url encoded string would be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%2B1206"},"children":[]}]}]}]},{"name":"numberPattern.searchPattern","in":"query","schemaId":"schema_688","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":"CONTAIN"},"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":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numbers that begin with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberPattern.pattern"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entered. Often used to search for a specific area code."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_683","description":"The maximum number of items to return, server can enforce an upper limit and overwrite the value."},{"name":"pageToken","in":"query","schemaId":"schema_682","description":"The next page token value returned from a previous listing."},{"name":"orderBy","in":"query","schemaId":"schema_681","description":"Parameter used to order the returned hosting orders"},{"name":"servicePlanId","in":"query","schemaId":"schema_679","description":"The hosting order servicePlanId","required":true},{"name":"campaignId","in":"query","schemaId":"schema_680","description":"The hosting order campaignId","required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1importedNumbers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/importedNumbers","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"}],"query":[{"name":"regionCode","in":"query","required":false,"example":"US","schemaId":"schema_676"},{"name":"numberPattern.pattern","in":"query","required":false,"example":"+1732","schemaId":"schema_687"},{"name":"numberPattern.searchPattern","in":"query","required":false,"example":"START","schemaId":"schema_688"},{"name":"pageSize","in":"query","required":false,"example":20,"schemaId":"schema_683"},{"name":"pageToken","in":"query","required":false,"example":"C2VNYXJrEg4KDCsxMjAxMjI2MzUyOQ==","schemaId":"schema_682"},{"name":"orderBy","in":"query","required":false,"schemaId":"schema_681"},{"name":"servicePlanId","in":"query","required":true,"example":"324e4567-e89b-12d3-a456-426614174000","schemaId":"schema_679"},{"name":"campaignId","in":"query","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_680"}],"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","500"],"pointer":"/v1/projects/{projectId}/importedNumbers","href":"imported-numbers/importnumberservice_listimportednumbers","openApiOperationId":"ImportNumberService_ListImportedNumbers","summary":"List imported numbers","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.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/ListImportedNumbersResponse"}},"schemaId":"components/schemas/ListImportedNumbersResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the page_token, number_pattern or order_by is not valid."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1importedNumbers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListImportedNumbersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListImportedNumbersResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/imported-numbers/importnumberservice_listimportednumbers"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/importedNumbers"},{"label":"Import number","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/imported-numbers/importnumberservice_importnumber","routeSlug":"/docs/numbers/api-reference/imported-hosting/imported-numbers/importnumberservice_importnumber","metadata":{"seo":{"title":"Import number","description":"You can use the Import Numbers API to import a non-Sinch number that you want to enable for SMS with Sinch as the Direct Connectivity Aggregator (DCA) without porting (or even partially porting) the number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ImportNumberService_ImportNumber","name":"Import number","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1importedNumbers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import 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":"You can use the Import Numbers API to import a non-Sinch number that you want to enable for SMS with Sinch as the Direct Connectivity Aggregator (DCA) without porting (or even partially porting) the number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Customers who are importing numbers (i.e. want to use their own NNID) will need to complete the NNID provisioning process to support proper message routing with the carriers. To learn more, refer to the article "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://community.sinch.com/t5/10DLC/How-can-you-provision-a-Network-Number-ID-NNID/ta-p/7040"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How can you provision a Network Number ID (NNID)?"},"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_675","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}~1importedNumbers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateImportedNumberRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1importedNumbers/post/requestBody/content/application~1json/examples/ProvisioningExample"]}},"schemaId":"components/schemas/CreateImportedNumberRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1importedNumbers/post/requestBody/content/application~1json/examples/ProvisioningExample"],"pointer":"/paths/~1v1~1projects~1{projectId}~1importedNumbers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/importedNumbers","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"}],"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/CreateImportedNumberRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1importedNumbers/post/requestBody/content/application~1json/examples/ProvisioningExample"]}},"responseCodes":["200","400","409","500"],"pointer":"/v1/projects/{projectId}/importedNumbers","href":"imported-numbers/importnumberservice_importnumber","openApiOperationId":"ImportNumberService_ImportNumber","summary":"Import number","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"schemaId":"components/schemas/CreateImportedNumberRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1importedNumbers/post/requestBody/content/application~1json/examples/ProvisioningExample"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateImportedNumberRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1importedNumbers/post/requestBody/content/application~1json/examples/ProvisioningExample"]}},"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/ImportedNumber"}},"schemaId":"components/schemas/ImportedNumber"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVALID_ARGUMENT: If the importedNumber.phoneNumber, importedNumber.smsConfiguration.servicePlanId is not valid."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"409","description":"The imported number already exists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1importedNumbers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ImportedNumber","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportedNumber"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"409","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/imported-numbers/importnumberservice_importnumber"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/importedNumbers"},{"label":"Get imported number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/imported-numbers/importnumberservice_getimportednumber","routeSlug":"/docs/numbers/api-reference/imported-hosting/imported-numbers/importnumberservice_getimportednumber","metadata":{"seo":{"title":"Get imported number","description":"Returns the imported number you specify in the path."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ImportNumberService_GetImportedNumber","name":"Get imported number","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get imported number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the imported number you specify in the path."},{"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_675","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_686","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":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/importedNumbers/{phoneNumber}","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"},{"name":"phoneNumber","in":"path","required":true,"example":"+12025550134","schemaId":"schema_686"}],"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}/importedNumbers/{phoneNumber}","href":"imported-numbers/importnumberservice_getimportednumber","openApiOperationId":"ImportNumberService_GetImportedNumber","summary":"Get imported number","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.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/ImportedNumberResponse"}},"schemaId":"components/schemas/ImportedNumberResponse"},{"code":"404","description":"The imported number could not be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ImportedNumberResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportedNumberResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/imported-numbers/importnumberservice_getimportednumber"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/importedNumbers/{phoneNumber}"},{"label":"Delete imported number","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/imported-numbers/importnumberservice_deleteimportednumber","routeSlug":"/docs/numbers/api-reference/imported-hosting/imported-numbers/importnumberservice_deleteimportednumber","metadata":{"seo":{"title":"Delete imported number","description":"Delete an imported number from the project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ImportNumberService_DeleteImportedNumber","name":"Delete imported number","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete imported number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete an imported number from the 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_675","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_686","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":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/projects/{projectId}/importedNumbers/{phoneNumber}","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"},{"name":"phoneNumber","in":"path","required":true,"example":"+12025550134","schemaId":"schema_686"}],"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}/importedNumbers/{phoneNumber}","href":"imported-numbers/importnumberservice_deleteimportednumber","openApiOperationId":"ImportNumberService_DeleteImportedNumber","summary":"Delete imported number","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.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"},{"code":"404","description":"The imported number could not be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/imported-numbers/importnumberservice_deleteimportednumber"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/importedNumbers/{phoneNumber}"},{"label":"Update imported number","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/imported-numbers/importnumberservice_updateimportednumber","routeSlug":"/docs/numbers/api-reference/imported-hosting/imported-numbers/importnumberservice_updateimportednumber","metadata":{"seo":{"title":"Update imported number","description":"Update an imported phone number. You can perform the following updates:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ImportNumberService_UpdateImportedNumber","name":"Update imported number","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update imported 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 imported 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":[]}]}]}]}]},{"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_675","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_686","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":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ImportedNumber","exampleIds":["paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/UnlinkNumber","paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/LinkNumber"]}},"schemaId":"components/schemas/ImportedNumber","exampleIds":["paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/UnlinkNumber","paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/LinkNumber"],"pointer":"/paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/projects/{projectId}/importedNumbers/{phoneNumber}","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"},{"name":"phoneNumber","in":"path","required":true,"example":"+12025550134","schemaId":"schema_686"}],"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/ImportedNumber","exampleIds":["paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/UnlinkNumber","paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/LinkNumber"]}},"responseCodes":["200","400","404","500"],"pointer":"/v1/projects/{projectId}/importedNumbers/{phoneNumber}","href":"imported-numbers/importnumberservice_updateimportednumber","openApiOperationId":"ImportNumberService_UpdateImportedNumber","summary":"Update imported number","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"schemaId":"components/schemas/ImportedNumber","exampleIds":["paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/UnlinkNumber","paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/LinkNumber"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ImportedNumber","exampleIds":["paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/UnlinkNumber","paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/LinkNumber"]}},"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/ImportedNumber"}},"schemaId":"components/schemas/ImportedNumber"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVALID_ARGUMENT: If the fieldMask is not provided or importedNumber.smsConfiguration.servicePlanId is not valid."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The imported number could not be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ImportedNumber","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportedNumber"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/imported-numbers/importnumberservice_updateimportednumber"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/importedNumbers/{phoneNumber}"}],"content":{"contentType":"group","meta":{"name":"Imported Numbers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Imported Numbers","showPageActions":true},{"nodeType":"markdoc","content":"Use the Imported Numbers API endpoints to list imported numbers or import a number that's already been provisioned with an NNID for use with Sinch. Imported numbers can be used with Sinch SMS services.\n\nNote: The SMS enablement process is only supported in United States and Canada."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/importedNumbers","summary":"List imported numbers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/imported-numbers/importnumberservice_listimportednumbers","deprecated":false},{"title":"/v1/projects/{projectId}/importedNumbers","summary":"Import number","prefix":{"name":"post","color":"post"},"badges":[],"link":"/imported-numbers/importnumberservice_importnumber","deprecated":false},{"title":"/v1/projects/{projectId}/importedNumbers/{phoneNumber}","summary":"Get imported number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/imported-numbers/importnumberservice_getimportednumber","deprecated":false},{"title":"/v1/projects/{projectId}/importedNumbers/{phoneNumber}","summary":"Delete imported number","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/imported-numbers/importnumberservice_deleteimportednumber","deprecated":false},{"title":"/v1/projects/{projectId}/importedNumbers/{phoneNumber}","summary":"Update imported number","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/imported-numbers/importnumberservice_updateimportednumber","deprecated":false}]}]}]}]}},{"type":"group","label":"Qualified Numbers","link":"/docs/numbers/api-reference/imported-hosting/qualified-numbers","routeSlug":"/docs/numbers/api-reference/imported-hosting/qualified-numbers","items":[{"label":"List qualified numbers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/qualified-numbers/qualifiednumberservice_listqualifiednumbers","routeSlug":"/docs/numbers/api-reference/imported-hosting/qualified-numbers/qualifiednumberservice_listqualifiednumbers","metadata":{"seo":{"title":"List qualified numbers","description":"Returns a list of qualified numbers for the project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"QualifiedNumberService_ListQualifiedNumbers","name":"List qualified numbers","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List qualified numbers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of qualified numbers for the 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_675","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}~1qualifiedNumbers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"regionCode","in":"query","schemaId":"schema_676","description":"Region code to filter by. ISO 3166-1 alpha-2 country code of the phone number. Currently supported are US, CA"},{"name":"states","in":"query","schemaId":"schema_689","description":"The qualified number states","required":true},{"name":"pageSize","in":"query","schemaId":"schema_683","description":"The maximum number of items to return, server can enforce an upper limit and overwrite the value."},{"name":"pageToken","in":"query","schemaId":"schema_682","description":"The next page token value returned from a previous listing."},{"name":"orderBy","in":"query","schemaId":"schema_681","description":"Parameter used to order the returned hosting orders"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/qualifiedNumbers","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"}],"query":[{"name":"regionCode","in":"query","required":false,"example":"US","schemaId":"schema_676"},{"name":"states","in":"query","required":true,"example":"GLOBAL_PROCESS_STATE_HOSTING_IN_PROGRESS","schemaId":"schema_689"},{"name":"pageSize","in":"query","required":false,"example":20,"schemaId":"schema_683"},{"name":"pageToken","in":"query","required":false,"example":"C2VNYXJrEg4KDCsxMjAxMjI2MzUyOQ==","schemaId":"schema_682"},{"name":"orderBy","in":"query","required":false,"schemaId":"schema_681"}],"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}/qualifiedNumbers","href":"qualified-numbers/qualifiednumberservice_listqualifiednumbers","openApiOperationId":"QualifiedNumberService_ListQualifiedNumbers","summary":"List qualified numbers","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.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/ListQualifiedNumber"}},"schemaId":"components/schemas/ListQualifiedNumber"},{"code":"404","description":"NOT FOUND: The resource could not be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListQualifiedNumber","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListQualifiedNumber"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/qualified-numbers/qualifiednumberservice_listqualifiednumbers"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/qualifiedNumbers"},{"label":"Get qualified number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/qualified-numbers/qualifiednumberservice_getqualifiednumber","routeSlug":"/docs/numbers/api-reference/imported-hosting/qualified-numbers/qualifiednumberservice_getqualifiednumber","metadata":{"seo":{"title":"Get qualified number","description":"Return a qualified number as specified by the phone number in the path."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"QualifiedNumberService_GetQualifiedNumber","name":"Get qualified number","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers~1{phoneNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get qualified number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Return a qualified number as specified by the phone number in the path."},{"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_675","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_686","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":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers~1{phoneNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{projectId}/qualifiedNumbers/{phoneNumber}","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"},{"name":"phoneNumber","in":"path","required":true,"example":"+12025550134","schemaId":"schema_686"}],"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}/qualifiedNumbers/{phoneNumber}","href":"qualified-numbers/qualifiednumberservice_getqualifiednumber","openApiOperationId":"QualifiedNumberService_GetQualifiedNumber","summary":"Get qualified number","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.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/QualifiedNumber"}},"schemaId":"components/schemas/QualifiedNumber"},{"code":"404","description":"NOT FOUND: The resource could not be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers~1{phoneNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QualifiedNumber","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QualifiedNumber"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/qualified-numbers/qualifiednumberservice_getqualifiednumber"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/qualifiedNumbers/{phoneNumber}"},{"label":"Delete qualified number","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/qualified-numbers/qualifiednumberservice_deletequalifiednumber","routeSlug":"/docs/numbers/api-reference/imported-hosting/qualified-numbers/qualifiednumberservice_deletequalifiednumber","metadata":{"seo":{"title":"Delete qualified number","description":"Deletes a qualified number as specified by the phone number in the path."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"QualifiedNumberService_DeleteQualifiedNumber","name":"Delete qualified number","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers~1{phoneNumber}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete qualified number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a qualified number as specified by the phone number in the path."},{"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_675","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_686","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":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers~1{phoneNumber}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/projects/{projectId}/qualifiedNumbers/{phoneNumber}","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"},{"name":"phoneNumber","in":"path","required":true,"example":"+12025550134","schemaId":"schema_686"}],"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}/qualifiedNumbers/{phoneNumber}","href":"qualified-numbers/qualifiednumberservice_deletequalifiednumber","openApiOperationId":"QualifiedNumberService_DeleteQualifiedNumber","summary":"Delete qualified number","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.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"},{"code":"404","description":"NOT FOUND: The resource could not be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers~1{phoneNumber}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/qualified-numbers/qualifiednumberservice_deletequalifiednumber"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/qualifiedNumbers/{phoneNumber}"},{"label":"Create qualified number batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/qualified-numbers/qualifiednumberservice_batchcreatequalifiednumbers","routeSlug":"/docs/numbers/api-reference/imported-hosting/qualified-numbers/qualifiednumberservice_batchcreatequalifiednumbers","metadata":{"seo":{"title":"Create qualified number batch","description":"Create a request to qualify a batch of numbers. After you have submitted the request, you must send an email to orders@sinch.com attaching all of the invoices related to the phone numbers in the request. In most cases, it will take the Sinch team 1-3 days to review your documentation and qualify your numbers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"QualifiedNumberService_BatchCreateQualifiedNumbers","name":"Create qualified number batch","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:addNumbers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create qualified number batch","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 request to qualify a batch of numbers. After you have submitted the request, you must send an email to orders@sinch.com attaching all of the invoices related to the phone numbers in the request. In most cases, it will take the Sinch team 1-3 days to review your documentation and qualify your numbers."},"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_675","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}~1qualifiedNumbers:addNumbers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchCreateQualifiedNumbersRequest"}},"schemaId":"components/schemas/BatchCreateQualifiedNumbersRequest","pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:addNumbers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/qualifiedNumbers:addNumbers","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"}],"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/BatchCreateQualifiedNumbersRequest"}},"responseCodes":["200","404","500"],"pointer":"/v1/projects/{projectId}/qualifiedNumbers:addNumbers","href":"qualified-numbers/qualifiednumberservice_batchcreatequalifiednumbers","openApiOperationId":"QualifiedNumberService_BatchCreateQualifiedNumbers","summary":"Create qualified number batch","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"schemaId":"components/schemas/BatchCreateQualifiedNumbersRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchCreateQualifiedNumbersRequest"}},"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/BatchCreateQualifiedNumbersResponse"}},"schemaId":"components/schemas/BatchCreateQualifiedNumbersResponse"},{"code":"404","description":"NOT FOUND: The resource could not be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:addNumbers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchCreateQualifiedNumbersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchCreateQualifiedNumbersResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/qualified-numbers/qualifiednumberservice_batchcreatequalifiednumbers"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/qualifiedNumbers:addNumbers"},{"label":"Text enable numbers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/qualified-numbers/qualifiednumberservice_textenablenumbers","routeSlug":"/docs/numbers/api-reference/imported-hosting/qualified-numbers/qualifiednumberservice_textenablenumbers","metadata":{"seo":{"title":"Text enable numbers","description":"Enables text capability for the specified qualified numbers. You can enable up to 500 numbers at once. To enable a number for SMS, you must include a Campaign ID and billing information for a Letter of Authorization to be generated. The information required can differ depending on if you are a direct customer of Sinch or a reseller. The Letter of Authorization will be sent to the email you provide in the request to be e-signed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"QualifiedNumberService_TextEnableNumbers","name":"Text enable numbers","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableNumbers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Text enable numbers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Enables text capability for the specified qualified numbers. You can enable up to 500 numbers at once. To enable a number for SMS, you must include a Campaign ID and billing information for a Letter of Authorization to be generated. The information required can differ depending on if you are a direct customer of Sinch or a reseller. The Letter of Authorization will be sent to the email you provide in the request to be e-signed."},{"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_675","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}~1qualifiedNumbers:textEnableNumbers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TextEnableNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableNumbers/post/requestBody/content/application~1json/examples/directLOAExample","paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableNumbers/post/requestBody/content/application~1json/examples/resellerLOAExample"]}},"schemaId":"components/schemas/TextEnableNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableNumbers/post/requestBody/content/application~1json/examples/directLOAExample","paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableNumbers/post/requestBody/content/application~1json/examples/resellerLOAExample"],"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableNumbers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/qualifiedNumbers:textEnableNumbers","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"}],"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/TextEnableNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableNumbers/post/requestBody/content/application~1json/examples/directLOAExample","paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableNumbers/post/requestBody/content/application~1json/examples/resellerLOAExample"]}},"responseCodes":["200","404","500"],"pointer":"/v1/projects/{projectId}/qualifiedNumbers:textEnableNumbers","href":"qualified-numbers/qualifiednumberservice_textenablenumbers","openApiOperationId":"QualifiedNumberService_TextEnableNumbers","summary":"Text enable numbers","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"schemaId":"components/schemas/TextEnableNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableNumbers/post/requestBody/content/application~1json/examples/directLOAExample","paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableNumbers/post/requestBody/content/application~1json/examples/resellerLOAExample"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TextEnableNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableNumbers/post/requestBody/content/application~1json/examples/directLOAExample","paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableNumbers/post/requestBody/content/application~1json/examples/resellerLOAExample"]}},"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/TextEnableResponse"}},"schemaId":"components/schemas/TextEnableResponse"},{"code":"404","description":"NOT FOUND: The resource could not be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableNumbers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TextEnableResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TextEnableResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/qualified-numbers/qualifiednumberservice_textenablenumbers"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/qualifiedNumbers:textEnableNumbers"},{"label":"Text enable Toll Free qualified numbers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/qualified-numbers/qualifiednumberstextenabletollfreenumbers","routeSlug":"/docs/numbers/api-reference/imported-hosting/qualified-numbers/qualifiednumberstextenabletollfreenumbers","metadata":{"seo":{"title":"Text enable Toll Free qualified numbers","description":"Text enable Toll Free qualified numbers of a specific project by creating a hosting order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"QualifiedNumbersTextEnableTollFreeNumbers","name":"Text enable Toll Free qualified numbers","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Text enable Toll Free qualified numbers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Text enable Toll Free qualified numbers of a specific project by creating a hosting order."},{"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_675","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}~1qualifiedNumbers:textEnableTollFreeNumbers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TextEnableTollFreeNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers"]}},"schemaId":"components/schemas/TextEnableTollFreeNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers"],"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/requestBody","description":"The request to text-enable hosting orders Toll Free numbers in the current project"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/qualifiedNumbers:textEnableTollFreeNumbers","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"}],"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/TextEnableTollFreeNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers"]}},"responseCodes":["200","400","404","409","500"],"pointer":"/v1/projects/{projectId}/qualifiedNumbers:textEnableTollFreeNumbers","href":"qualified-numbers/qualifiednumberstextenabletollfreenumbers","openApiOperationId":"QualifiedNumbersTextEnableTollFreeNumbers","summary":"Text enable Toll Free qualified numbers","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"schemaId":"components/schemas/TextEnableTollFreeNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TextEnableTollFreeNumbersRequest","exampleIds":["paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers"]}},"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 with a hosting order, or an error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HostingOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderTextEnableResponse","paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderImportNumbersResponse"]}},"schemaId":"components/schemas/HostingOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderTextEnableResponse","paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderImportNumbersResponse"]},{"code":"400","description":"Status returned if any of the projectId, displayName, regionCode, numbers, nnid, servicePlanId or campaignId parameters are not valid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/responses/400/content/application~1json/examples/invalidServicePlanId"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/responses/400/content/application~1json/examples/invalidServicePlanId"]},{"code":"404","description":"The imported number, project, hosting order, qualified number or phone number could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"409","description":"The imported number already exists and cannot be created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/HostingOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderTextEnableResponse","paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderImportNumbersResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HostingOrder","exampleIds":["paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderTextEnableResponse","paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderImportNumbersResponse"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/responses/400/content/application~1json/examples/invalidServicePlanId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/responses/400/content/application~1json/examples/invalidServicePlanId"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"409","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/qualified-numbers/qualifiednumberstextenabletollfreenumbers"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/qualifiedNumbers:textEnableTollFreeNumbers"},{"label":"Verify voice challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/qualified-numbers/qualifiednumberservice_verifyvoicechallenge","routeSlug":"/docs/numbers/api-reference/imported-hosting/qualified-numbers/qualifiednumberservice_verifyvoicechallenge","metadata":{"seo":{"title":"Verify voice challenge","description":"Uses the code you received from the Send voice challenge operation to verify that you own the phone number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"QualifiedNumberService_VerifyVoiceChallenge","name":"Verify voice challenge","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers~1{phoneNumber}:verifyVoiceChallenge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify voice challenge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Uses the code you received from the Send voice challenge operation to verify that you own the 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_675","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_686","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":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers~1{phoneNumber}:verifyVoiceChallenge/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerifyVoiceChallengeRequest"}},"schemaId":"components/schemas/VerifyVoiceChallengeRequest","pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers~1{phoneNumber}:verifyVoiceChallenge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/qualifiedNumbers/{phoneNumber}:verifyVoiceChallenge","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"},{"name":"phoneNumber","in":"path","required":true,"example":"+12025550134","schemaId":"schema_686"}],"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/VerifyVoiceChallengeRequest"}},"responseCodes":["200","404","500"],"pointer":"/v1/projects/{projectId}/qualifiedNumbers/{phoneNumber}:verifyVoiceChallenge","href":"qualified-numbers/qualifiednumberservice_verifyvoicechallenge","openApiOperationId":"QualifiedNumberService_VerifyVoiceChallenge","summary":"Verify voice challenge","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"schemaId":"components/schemas/VerifyVoiceChallengeRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VerifyVoiceChallengeRequest"}},"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/QualifiedNumber"}},"schemaId":"components/schemas/QualifiedNumber"},{"code":"404","description":"NOT FOUND: The resource could not be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers~1{phoneNumber}:verifyVoiceChallenge/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QualifiedNumber","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QualifiedNumber"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/qualified-numbers/qualifiednumberservice_verifyvoicechallenge"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/qualifiedNumbers/{phoneNumber}:verifyVoiceChallenge"},{"label":"Send voice challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/numbers/api-reference/imported-hosting/qualified-numbers/qualifiednumberservice_sendvoicechallenge","routeSlug":"/docs/numbers/api-reference/imported-hosting/qualified-numbers/qualifiednumberservice_sendvoicechallenge","metadata":{"seo":{"title":"Send voice challenge","description":"Sends a voice challenge to the phone number specified in the path to verify that you own the number. The voice call contains a code that you must use to verify the number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"QualifiedNumberService_SendVoiceChallenge","name":"Send voice challenge","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers~1{phoneNumber}:sendVoiceChallenge/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send voice challenge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends a voice challenge to the phone number specified in the path to verify that you own the number. The voice call contains a code that you must use to verify the 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_675","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_686","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":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers~1{phoneNumber}:sendVoiceChallenge/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{projectId}/qualifiedNumbers/{phoneNumber}:sendVoiceChallenge","servers":[{"url":"https://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"},{"name":"phoneNumber","in":"path","required":true,"example":"+12025550134","schemaId":"schema_686"}],"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}/qualifiedNumbers/{phoneNumber}:sendVoiceChallenge","href":"qualified-numbers/qualifiednumberservice_sendvoicechallenge","openApiOperationId":"QualifiedNumberService_SendVoiceChallenge","summary":"Send voice challenge","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.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/QualifiedNumber"}},"schemaId":"components/schemas/QualifiedNumber"},{"code":"404","description":"NOT FOUND: The resource could not be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"INTERNAL: Internal server error. Typically, a server bug.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{projectId}~1qualifiedNumbers~1{phoneNumber}:sendVoiceChallenge/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QualifiedNumber","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QualifiedNumber"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/qualified-numbers/qualifiednumberservice_sendvoicechallenge"}],"panels":[]}]},"httpPath":"/v1/projects/{projectId}/qualifiedNumbers/{phoneNumber}:sendVoiceChallenge"}],"content":{"contentType":"group","meta":{"name":"Qualified Numbers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Qualified Numbers","showPageActions":true},{"nodeType":"markdoc","content":"You can use the Qualified Numbers API to qualify numbers you want Sinch to host and have available for use with Sinch SMS services. Qualifying a number involves verifying ownership of a number either by providing a one time passcode sent to the number by voice call or by providing invoices for multiple numbers. Once numbers are qualified, you can then enable those numbers for SMS text messaging services.\n\nNote: The SMS enablement process is only supported in United States and Canada."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{projectId}/qualifiedNumbers","summary":"List qualified numbers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/qualified-numbers/qualifiednumberservice_listqualifiednumbers","deprecated":false},{"title":"/v1/projects/{projectId}/qualifiedNumbers/{phoneNumber}","summary":"Get qualified number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/qualified-numbers/qualifiednumberservice_getqualifiednumber","deprecated":false},{"title":"/v1/projects/{projectId}/qualifiedNumbers/{phoneNumber}","summary":"Delete qualified number","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/qualified-numbers/qualifiednumberservice_deletequalifiednumber","deprecated":false},{"title":"/v1/projects/{projectId}/qualifiedNumbers:addNumbers","summary":"Create qualified number batch","prefix":{"name":"post","color":"post"},"badges":[],"link":"/qualified-numbers/qualifiednumberservice_batchcreatequalifiednumbers","deprecated":false},{"title":"/v1/projects/{projectId}/qualifiedNumbers:textEnableNumbers","summary":"Text enable numbers","prefix":{"name":"post","color":"post"},"badges":[],"link":"/qualified-numbers/qualifiednumberservice_textenablenumbers","deprecated":false},{"title":"/v1/projects/{projectId}/qualifiedNumbers:textEnableTollFreeNumbers","summary":"Text enable Toll Free qualified numbers","prefix":{"name":"post","color":"post"},"badges":[],"link":"/qualified-numbers/qualifiednumberstextenabletollfreenumbers","deprecated":false},{"title":"/v1/projects/{projectId}/qualifiedNumbers/{phoneNumber}:verifyVoiceChallenge","summary":"Verify voice challenge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/qualified-numbers/qualifiednumberservice_verifyvoicechallenge","deprecated":false},{"title":"/v1/projects/{projectId}/qualifiedNumbers/{phoneNumber}:sendVoiceChallenge","summary":"Send voice challenge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/qualified-numbers/qualifiednumberservice_sendvoicechallenge","deprecated":false}]}]}]}]}},{"type":"group","label":"Imported Numbers and Hosting Orders Callbacks","link":"/docs/numbers/api-reference/imported-hosting/imported-numbers-and-hosting-orders-callbacks","routeSlug":"/docs/numbers/api-reference/imported-hosting/imported-numbers-and-hosting-orders-callbacks","items":[{"type":"link","label":"Secure Webhook Endpoints with HMAC","link":"/docs/numbers/api-reference/imported-hosting/imported-numbers-and-hosting-orders-callbacks/secure-webhook-endpoints-with-hmac","routeSlug":"/docs/numbers/api-reference/imported-hosting/imported-numbers-and-hosting-orders-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":"imported-numbers-and-hosting-orders-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 essentially it is just special code that can be used to check if a message hasn't been tampered 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/imported-hosting/imported-numbers-and-hosting-orders-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/imported-hosting/imported-numbers-and-hosting-orders-callbacks/hmac-verification","routeSlug":"/docs/numbers/api-reference/imported-hosting/imported-numbers-and-hosting-orders-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":"imported-numbers-and-hosting-orders-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/imported-hosting/imported-numbers-and-hosting-orders-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/imported-hosting/imported-numbers-and-hosting-orders-callbacks/getcallbackconfiguration","routeSlug":"/docs/numbers/api-reference/imported-hosting/imported-numbers-and-hosting-orders-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":false},"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_675","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://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"}],"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}/callbackConfiguration","href":"imported-numbers-and-hosting-orders-callbacks/getcallbackconfiguration","openApiOperationId":"GetCallbackConfiguration","summary":"Get callbacks configuration","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.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":"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":"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":"/imported-numbers-and-hosting-orders-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/imported-hosting/imported-numbers-and-hosting-orders-callbacks/updatecallbackconfiguration","routeSlug":"/docs/numbers/api-reference/imported-hosting/imported-numbers-and-hosting-orders-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_675","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://imported.numbers.api.sinch.com","description":"Global API"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"d1923022-5199-4bb3-a513-c47b3a656bc5","schemaId":"schema_675"}],"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","404","500"],"pointer":"/v1/projects/{projectId}/callbackConfiguration","href":"imported-numbers-and-hosting-orders-callbacks/updatecallbackconfiguration","openApiOperationId":"UpdateCallbackConfiguration","summary":"Update callback configuration","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://imported.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":"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":"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":"/imported-numbers-and-hosting-orders-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/imported-hosting/imported-numbers-and-hosting-orders-callbacks/importednumberservice_eventscallback","routeSlug":"/docs/numbers/api-reference/imported-hosting/imported-numbers-and-hosting-orders-callbacks/importednumberservice_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":"ImportedNumberService_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://imported.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":"imported-numbers-and-hosting-orders-callbacks/importednumberservice_eventscallback","openApiOperationId":"ImportedNumberService_EventsCallback","summary":"Event notification","securityGroups":[{"Basic":[]},{"OAuth2.0":[]}]},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://imported.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":"/imported-numbers-and-hosting-orders-callbacks/importednumberservice_eventscallback"}],"panels":[]}]},"httpPath":"EventsCallback"}],"content":{"contentType":"group","meta":{"name":"Imported Numbers and Hosting Orders Callbacks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Imported Numbers and Hosting Orders 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":"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":"/imported-numbers-and-hosting-orders-callbacks/getcallbackconfiguration","deprecated":false},{"title":"/v1/projects/{projectId}/callbackConfiguration","summary":"Update callback configuration","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/imported-numbers-and-hosting-orders-callbacks/updatecallbackconfiguration","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"EventsCallback","summary":"Event notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/imported-numbers-and-hosting-orders-callbacks/importednumberservice_eventscallback","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CreateImportedNumberRequest":{"id":"components/schemas/CreateImportedNumberRequest","kind":"json-schema","title":"Create Imported Number","data":{"title":"Create Imported Number","required":["regionCode","smsConfiguration"],"allOf":[{"$ref":"#/components/schemas/ImportedNumber"}]}},"components/schemas/CreateTextEnabledNumberRequest":{"id":"components/schemas/CreateTextEnabledNumberRequest","kind":"json-schema","title":"Text Enable Number","data":{"title":"Text Enable Number","required":["projectId","phoneNumber","regionCode"],"type":"object","properties":{"projectId":{"type":"string","description":"The ID of the project resource. You can find your project ID on dashboard.sinch.com.","example":"YOUR_project_id"},"phoneNumber":{"type":"string","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 e.164 format with leading +."},"children":[]}]}]}],"example":"+12025550134"},"regionCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of the phone number. Example US, UK or SE.","example":"US"},"displayName":{"type":"string","description":"User supplied name for the phone number.","example":"MyPhoneNumber"},"servicePlanId":{"type":"string","description":"The service plan ID for the phone number.","example":"YOUR_service_plan_id"},"campaignId":{"type":"string","description":"The campaign ID for the phone number.","example":"YOUR_campaign_id"},"nnid":{"type":"string","description":"The Net Number ID identifying the phone number."}},"description":"Request message for creating text enabled phone number."}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","properties":{"code":{"example":"404","type":"string","description":"The HTTP response code for the error."},"message":{"example":"The imported number could not be found.","type":"string","description":"The friendly message describing the reason for the error response."},"status":{"example":"NOT_FOUND","type":"string","description":"The HTTP response status for the error."}},"description":"The schema for an error response."}},"components/schemas/ImportedNumber":{"id":"components/schemas/ImportedNumber","kind":"json-schema","title":"ImportedNumber","data":{"type":"object","properties":{"phoneNumber":{"type":"string","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 e.164 format with leading +."},"children":[]}]}]}],"example":"+12025550134"},"projectId":{"type":"string","description":"The ID of the project resource. You can find your project ID on dashboard.sinch.com.","example":"YOUR_project_id"},"regionCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of the phone number. Example US, UK or SE.","example":"US"},"displayName":{"type":"string","description":"User supplied name for the phone number.","example":"MyPhoneNumber"},"smsConfiguration":{"$ref":"#/components/schemas/SmsConfiguration"},"callbackUrl":{"type":"string","description":"The client's callback URL to be called upon finishing the number import.","example":"https://www.your-callback-server.com/callback"}}}},"components/schemas/ImportedNumberResponse":{"id":"components/schemas/ImportedNumberResponse","kind":"json-schema","title":"ImportedNumberResponse","data":{"allOf":[{"$ref":"#/components/schemas/ImportedNumber"},{"$ref":"#/components/schemas/MnoConfiguration"},{"$ref":"#/components/schemas/SmsProvisioning"},{"$ref":"#/components/schemas/CampaignProvisioning"}]}},"components/schemas/ListImportedNumbersResponse":{"id":"components/schemas/ListImportedNumbersResponse","kind":"json-schema","title":"List Imported Numbers Response","data":{"title":"List Imported Numbers Response","type":"object","properties":{"importedNumbers":{"type":"array","items":{"$ref":"#/components/schemas/ImportedNumberResponse"},"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":"ListImportedNumbers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"nextPageToken":{"type":"string","description":"The token to be used for listing the next page."},"totalSize":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://cloud.google.com/apis/design/design_patterns#list_pagination"},"children":[]}]}]}],"format":"int32"}},"description":"Response message to list your imported phone numbers"}},"components/schemas/SmsProvisioning":{"id":"components/schemas/SmsProvisioning","kind":"json-schema","title":"SmsProvisioning","data":{"description":"An object giving details about the SMS provisioning of the number.","type":"object","properties":{"smsProvisioning":{"description":"An object giving details about the SMS provisioning of the number.","type":"object","properties":{"serviceType":{"$ref":"#/components/schemas/ServiceType"},"serviceId":{"description":"A unique identifier for the service being provisioned.","type":"string","example":"0130a21c9ed6461ba3a1fefda83f7ec7"},"type":{"$ref":"#/components/schemas/Type"},"state":{"$ref":"#/components/schemas/State"},"updateTime":{"type":"string","description":"A timestamp in ISO 8601 format (UTC) indicating the last time the provisioning status was updated.","example":"2023-02-02T21:00:07.467353Z"},"errorMessage":{"type":"string","description":"If an error occurred during provisioning, this field will contain a descriptive message. It will be an empty string if no error is present.","example":""},"errorCode":{"type":"string","description":"If an error occurred during provisioning, this field will contain the error code. This field is also an empty string when no error has occurred.","example":""}}}}}},"components/schemas/CampaignProvisioning":{"id":"components/schemas/CampaignProvisioning","kind":"json-schema","title":"CampaignProvisioning","data":{"description":"An object giving details about the campaign provisioning of the number.","type":"object","properties":{"campaignProvisioning":{"description":"An object giving details about the campaign provisioning of the number.","type":"object","properties":{"serviceType":{"$ref":"#/components/schemas/ServiceType"},"serviceId":{"description":"A unique identifier for the service being provisioned.","type":"string","example":"CDCQLGJ"},"type":{"$ref":"#/components/schemas/Type"},"state":{"$ref":"#/components/schemas/State"},"updateTime":{"type":"string","description":"A timestamp in ISO 8601 format (UTC) indicating the last time the provisioning status was updated.","example":"2023-02-02T21:00:07.467353Z"},"errorMessage":{"type":"string","description":"If an error occurred during provisioning, this field will contain a descriptive message. It will be an empty string if no error is present.","example":""},"errorCode":{"type":"string","description":"If an error occurred during provisioning, this field will contain the error code. This field is also an empty string when no error has occurred.","example":""}}}}}},"components/schemas/ServiceType":{"id":"components/schemas/ServiceType","kind":"json-schema","title":"ServiceType","data":{"description":"The type of service.","type":"string","enum":["SMS","CAMPAIGN"],"x-enumDescriptions":{"SMS":"SMS provisioning.","CAMPAIGN":"Campaign provisioning."}}},"components/schemas/Type":{"id":"components/schemas/Type","kind":"json-schema","title":"Type","data":{"description":"Specifies the type of operation. This value of this field is either \"PROVISIONING\" or \"DEPROVISIONING\".","type":"string","enum":["PROVISIONING","DEPROVISIONING"],"x-enumDescriptions":{"PROVISIONING":"The operation is provisioning the number.","DEPROVISIONING":"The operation is deprovisioning the number."}}},"components/schemas/ScheduledProvisioning":{"id":"components/schemas/ScheduledProvisioning","kind":"json-schema","title":"ScheduledProvisioning","data":{"readOnly":true,"type":"object","properties":{"servicePlanId":{"type":"string","description":"Service plan of the scheduled provisioning task.","example":"YOUR_service_plan_id"},"status":{"type":"integer","description":"Status of the pending change.","format":"enum"},"lastUpdatedTime":{"type":"string","description":"Timestamp when the status was last updated.","format":"date-time"},"campaignId":{"type":"string","description":"The campaign of the scheduled provisioning task.","example":"YOUR_campaign_id"},"errorCodes":{"type":"array","items":{"type":"integer","format":"enum"},"description":"A list of error codes, if applicable, for the scheduled provisioning task."}},"description":"Ongoing Provisioning for SMS service"}},"components/schemas/MnoConfiguration":{"id":"components/schemas/MnoConfiguration","kind":"json-schema","title":"MnoConfiguration","data":{"type":"object","properties":{"mnoConfiguration":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The mnoConfiguration object represents the status and progress of configuration operations for SMS and MMS services across different carriers (AT&T and T-Mobile). Each key within this object (smsAtt, smsTmo, mmsAtt and mmsTmo) corresponds to a specific service type (SMS or MMS) associated with a particular mobile network operator."},"children":[]}]}]}],"properties":{"smsAtt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about SMS-enabled ATT&T numbers."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CarrierState"},{"type":"object","properties":{"operation":{"$ref":"#/components/schemas/Operation"}}}]},"smsTmo":{"description":"Contains information about SMS-enabled T-Mobile numbers.","allOf":[{"$ref":"#/components/schemas/CarrierState"},{"type":"object","properties":{"operation":{"$ref":"#/components/schemas/Operation"}}}]},"mmsAtt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about MMS-enabled AT&T numbers."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CarrierState"},{"type":"object","properties":{"operation":{"$ref":"#/components/schemas/Operation"}}}]},"mmsTmo":{"description":"Contains information about MMS-enabled T-Mobile numbers.","allOf":[{"$ref":"#/components/schemas/CarrierState"},{"type":"object","properties":{"operation":{"$ref":"#/components/schemas/Operation"}}}]}}}}}},"components/schemas/CarrierState":{"id":"components/schemas/CarrierState","kind":"json-schema","title":"CarrierState","data":{"type":"object","description":"Contains information about the state of the carrier.","properties":{"state":{"$ref":"#/components/schemas/State"},"errorCode":{"$ref":"#/components/schemas/ErrorCode"},"errorMessage":{"$ref":"#/components/schemas/ErrorMessage"},"updateTime":{"$ref":"#/components/schemas/UpdateTime"}}}},"components/schemas/State":{"id":"components/schemas/State","kind":"json-schema","title":"State","data":{"type":"string","description":"Indicates the current state of the operation.","enum":["DONE","FAILED","IN_PROGRESS","WAITING","STATE_UNSPECIFIED"],"x-enumDescriptions":{"DONE":"The operation was completed successfully.","FAILED":"The operation has failed.","IN_PROGRESS":"The operation is currently in progress.","WAITING":"The operation is pending and has not yet started.","STATE_UNSPECIFIED":"The state is unspecified."},"example":"DONE"}},"components/schemas/Operation":{"id":"components/schemas/Operation","kind":"json-schema","title":"Operation","data":{"type":"string","description":"Specifies the type of action being performed.","enum":["PROVISIONING","DEPROVISIONING","OPERATION_UNSPECIFIED"],"x-enumDescriptions":{"PROVISIONING":"The service is being configured or activated.","DEPROVISIONING":"The service is being deactivated or removed.","OPERATION_UNSPECIFIED":"The operation is unspecified."}}},"components/schemas/ErrorCode":{"id":"components/schemas/ErrorCode","kind":"json-schema","title":"ErrorCode","data":{"type":"string","description":"An optional string field that contains an error code if the operation failed. This field is empty (\"\") when there is no error.","example":""}},"components/schemas/ErrorMessage":{"id":"components/schemas/ErrorMessage","kind":"json-schema","title":"ErrorMessage","data":{"type":"string","description":"An optional string field that provides a human-readable message describing the error. This field is empty (\"\") when no error has occurred."}},"components/schemas/UpdateTime":{"id":"components/schemas/UpdateTime","kind":"json-schema","title":"UpdateTime","data":{"type":"string","description":"A timestamp in ISO 8601 format indicating the last time the status was updated.","example":"2025-04-02T19:45:28.650924Z"}},"components/schemas/SmsConfiguration":{"id":"components/schemas/SmsConfiguration","kind":"json-schema","title":"SmsConfiguration","data":{"type":"object","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 current SMS configuration for this number."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The `servicePlanId`` can be found when logging into dashboard.sinch.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the SMS>APIs section."},"children":[]}]}]}],"example":"YOUR_service_plan_id"},"scheduledProvisioning":{"$ref":"#/components/schemas/ScheduledProvisioning"},"campaignId":{"type":"string","description":"The current campaign ID assigned to this number.","example":"YOUR_campaign_id"},"migrateToSinchTmo":{"type":"boolean","readOnly":true,"description":"Displays if a number is assigned to another aggregator in T-Mobile's platform, and requires migration from previous aggregator to Sinch."}},"description":"Configuration for SMS"}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"description":"The address of the business.","required":["buildingNumber","street","city","state","postalCode","country"],"type":"object","properties":{"buildingNumber":{"type":"string","description":"The building number of the address.","example":"123"},"street":{"type":"string","description":"The street name of the address.","example":"1st"},"city":{"type":"string","description":"The city name of the address.","example":"New York"},"state":{"type":"string","description":"The state name of the address.","example":"NY"},"postalCode":{"type":"string","description":"The postal code of the address.","example":"00001"},"country":{"type":"string","description":"The country of the address.","example":"USA"}}}},"components/schemas/AuthorizedPerson":{"id":"components/schemas/AuthorizedPerson","kind":"json-schema","title":"AuthorizedPerson","data":{"description":"The person authorized and responsible for the hosting order.","required":["firstName","lastName","email"],"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the authorized person.","example":"John"},"lastName":{"type":"string","description":"The last name of the authorized person.","example":"Doe"},"email":{"type":"string","description":"The email address of the authorized person.","example":"john.doe@company.com"}}}},"components/schemas/BlanketLoaInfo":{"id":"components/schemas/BlanketLoaInfo","kind":"json-schema","title":"BlanketLoaInfo","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can set up a blanket Letter of Authorization (LoA) that will allow you to import numbers to your account without having to sign an LoA each time you submit a request. To set up a blanket LoA, email your account manager. Once the LoA has been approved, you can use this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blanketLoaInfo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object in your requests. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blanketLoaInfo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object should be sent as an empty object."},"children":[]}]}]}],"type":"object","properties":{}}},"components/schemas/DirectLoaInfo":{"id":"components/schemas/DirectLoaInfo","kind":"json-schema","title":"DirectLoaInfo","data":{"description":"Letter of Authorization for direct Sinch customers.","required":["authorisedPerson","address","currentVoiceCarrier"],"type":"object","properties":{"authorisedPerson":{"$ref":"#/components/schemas/AuthorizedPerson"},"address":{"$ref":"#/components/schemas/Address"},"currentVoiceCarrier":{"type":"string","description":"The current carrier you are using for voice services for the number you want to host on Sinch.","example":"TMO"}}}},"components/schemas/ImportHostingOrder":{"id":"components/schemas/ImportHostingOrder","kind":"json-schema","title":"ImportHostingOrder","data":{"type":"object","properties":{"projectId":{"type":"string","description":"The project ID to which the hosting order is associated.","example":"YOUR_project_id"},"hostingOrderId":{"type":"string","description":"The unique ID of the hosting order.","example":"YOUR_hosting_order_id"},"displayName":{"type":"string","description":"The friendly name of the hosting order.","example":"MyHostingOrder"},"regionCode":{"type":"string","description":"The region code of the hosting order. Number hosting is only available for the US and Canada, so you must enter either \"US\" or \"CA\".","example":"US"},"state":{"type":"string","enum":["HOSTING_ORDER_STATE_UNSPECIFIED","DRAFT","SUBMITTED","WAITING_FOR_LOA_SIGNATURE","IN_PROGRESS","COMPLETED","REJECTED"],"x-enumDescriptions":{"HOSTING_ORDER_STATE_UNSPECIFIED":"State is unspecified.","DRAFT":"Hosting order is a draft.","SUBMITTED":"Hosting order has been submitted.","WAITING_FOR_LOA_SIGNATURE":"Hosting order is waiting for the LoA signature.","IN_PROGRESS":"Hosting order is in progress.","COMPLETED":"Hosting order is completed.","REJECTED":"Hosting order is rejected."},"description":"The state of the hosting order."},"type":{"type":"string","enum":["HOSTING_ORDER_TYPE_UNSPECIFIED","IMPORT","TYPE_TEXT_ENABLE"],"x-enumDescriptions":{"HOSTING_ORDER_TYPE_UNSPECIFIED":"The type of hosting order is unspecified.","IMPORT":"Hosting order to import numbers.","TYPE_TEXT_ENABLE":"Hosting order to text-enable numbers."},"description":"The hosting order type."},"createdTime":{"type":"string","format":"date-time","description":"Timestamp when the hosting order was created","readOnly":true},"updatedTime":{"type":"string","format":"date-time","description":"Timestamp when the hosting order was last updated","readOnly":true},"servicePlanId":{"type":"string","description":"The service plan to which the hosting order is associated.","example":"YOUR_service_plan_id"},"campaignId":{"type":"string","description":"The campaign to which the hosting order is associated.","example":"YOUR_campaign_id"},"migrateToSinchTmo":{"type":"boolean","readOnly":true,"description":"Displays if a number is assigned to another aggregator in T-Mobile's platform, and requires migration from previous aggregator to Sinch."},"callbackUrl":{"type":"string","description":"The client's callback URL to be called upon finishing the number import.","example":"https://www.your-callback-server.com/callback"}}}},"components/schemas/HostingOrder":{"id":"components/schemas/HostingOrder","kind":"json-schema","title":"HostingOrder","data":{"type":"object","properties":{"projectId":{"type":"string","description":"The project ID to which the hosting order is associated.","example":"YOUR_project_id"},"hostingOrderId":{"type":"string","description":"The unique ID of the hosting order.","example":"YOUR_hosting_order_id"},"displayName":{"type":"string","description":"The friendly name of the hosting order.","example":"MyHostingOrder"},"regionCode":{"type":"string","description":"The region code of the hosting order. Number hosting is only available for the US and Canada, so you must enter either \"US\" or \"CA\".","example":"US"},"state":{"type":"string","enum":["HOSTING_ORDER_STATE_UNSPECIFIED","DRAFT","SUBMITTED","WAITING_FOR_LOA_SIGNATURE","IN_PROGRESS","COMPLETED","REJECTED"],"x-enumDescriptions":{"HOSTING_ORDER_STATE_UNSPECIFIED":"State is unspecified.","DRAFT":"Hosting order is a draft.","SUBMITTED":"Hosting order has been submitted.","WAITING_FOR_LOA_SIGNATURE":"Hosting order is waiting for the LoA signature.","IN_PROGRESS":"Hosting order is in progress.","COMPLETED":"Hosting order is completed.","REJECTED":"Hosting order is rejected."},"description":"The state of the hosting order."},"type":{"type":"string","enum":["HOSTING_ORDER_TYPE_UNSPECIFIED","IMPORT","TYPE_TEXT_ENABLE"],"x-enumDescriptions":{"HOSTING_ORDER_TYPE_UNSPECIFIED":"The type of hosting order is unspecified.","IMPORT":"Hosting order to import numbers.","TYPE_TEXT_ENABLE":"Hosting order to text-enable numbers."},"description":"The hosting order type."},"createdTime":{"type":"string","format":"date-time","description":"Timestamp when the hosting order was created","readOnly":true},"updatedTime":{"type":"string","format":"date-time","description":"Timestamp when the hosting order was last updated","readOnly":true},"scheduledOsrUpdateTime":{"type":"string","format":"date-time","description":"Timestamp when the OSR update will be done","readOnly":true},"servicePlanId":{"type":"string","description":"The service plan to which the hosting order is associated.","example":"YOUR_service_plan_id"},"campaignId":{"type":"string","description":"The campaign to which the hosting order is associated.","example":"YOUR_campaign_id"},"migrateToSinchTmo":{"type":"boolean","readOnly":true,"description":"Displays if a number is assigned to another aggregator in T-Mobile's platform, and requires migration from previous aggregator to Sinch."},"textEnableInfo":{"$ref":"#/components/schemas/TextEnableInfo"},"callbackUrl":{"type":"string","description":"The client's callback URL to be called upon finishing the number import.","example":"https://www.your-callback-server.com/callback"}}}},"components/schemas/HostingOrderNumber":{"id":"components/schemas/HostingOrderNumber","kind":"json-schema","title":"HostingOrderNumber","data":{"type":"object","properties":{"projectId":{"type":"string","description":"The project ID to which the number belongs.","example":"YOUR_project_id"},"hostingOrderId":{"type":"string","description":"The ID of the hosting order to which the number belongs.","example":"YOUR_hosting_order_id"},"phoneNumber":{"type":"string","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 e.164 format with leading +."},"children":[]}]}]}],"example":"+12025550134"},"osrUpdate":{"$ref":"#/components/schemas/HostingOrderNumber_OsrUpdate"},"campaignProvisioning":{"$ref":"#/components/schemas/HostingOrderNumber_CampaignProvisioning"},"platformProvisioning":{"$ref":"#/components/schemas/HostingOrderNumber_PlatformProvisioning"},"smsAtt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about hosted SMS AT&T numbers."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CarrierState"}]},"smsTmo":{"description":"Contains information about hosted SMS T-Mobile numbers.","allOf":[{"$ref":"#/components/schemas/CarrierState"}]},"mmsAtt":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains information about hosted MMS AT&T numbers."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CarrierState"}]},"mmsTmo":{"description":"Contains information about hosted MMS T-Mobile numbers.","allOf":[{"$ref":"#/components/schemas/CarrierState"}]}}}},"components/schemas/HostingOrderNumber_CampaignProvisioning":{"id":"components/schemas/HostingOrderNumber_CampaignProvisioning","kind":"json-schema","title":"HostingOrderNumber_CampaignProvisioning","data":{"description":"An object containing information about campaign provisioning.","type":"object","properties":{"campaignId":{"type":"string","description":"The campaign ID to which the hosting order is associated.","example":"YOUR_campaign_id"},"state":{"$ref":"#/components/schemas/State"}}}},"components/schemas/HostingOrderNumber_OsrUpdate":{"id":"components/schemas/HostingOrderNumber_OsrUpdate","kind":"json-schema","title":"HostingOrderNumber_OsrUpdate","data":{"description":"An object containing information about the OSR update.","type":"object","properties":{"nnid":{"type":"string","description":"The Net Number ID identifying the phone number."},"state":{"$ref":"#/components/schemas/State"}}}},"components/schemas/TextEnableTollFreeNumbersRequest":{"id":"components/schemas/TextEnableTollFreeNumbersRequest","kind":"json-schema","title":"Text enable Toll Free numbers request","data":{"type":"object","oneOf":[{"$ref":"#/components/schemas/TextEnableTollFreeNumbersDirectLoaInfoRequest"},{"$ref":"#/components/schemas/TextEnableTollFreeNumbersResellerLoaInfoRequest"}],"description":"Request for text enabling project Toll Free numbers.","title":"Text enable Toll Free numbers request"}},"components/schemas/TextEnableTollFreeNumbersLoaInfoCommon":{"id":"components/schemas/TextEnableTollFreeNumbersLoaInfoCommon","kind":"json-schema","title":"TextEnableTollFreeNumbersLoaInfoCommon","data":{"required":["projectId","regionCode","numbers","servicePlanId"],"type":"object","properties":{"projectId":{"type":"string","description":"The project id we want the numbers to be enabled for."},"displayName":{"type":"string","description":"The display name of the numbers."},"regionCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of the phone number. Example: US, CA"},"numbers":{"type":"array","items":{"type":"string"}},"scheduledZipwhipProvisioningTime":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional field which allow to determine when Zipwhip provisioning will be done. Timestamp needs to be from UTC zone. Important! If LOA is signed after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduledZipwhipProvisioningTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", date will be rescheduled to the next day at the same time."},"children":[]}]}]}]},"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 SMS service that the number will be linked to. 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":"."},"children":[]}]}]}]},"callbackUrl":{"type":"string","description":"The callback URL to be called for text enablement updates"}}}},"components/schemas/TextEnableTollFreeNumbersDirectLoaInfoRequest":{"id":"components/schemas/TextEnableTollFreeNumbersDirectLoaInfoRequest","kind":"json-schema","title":"TextEnableTollFreeNumbersDirectLoaInfoRequest","data":{"type":"object","properties":{"allOf":{"$ref":"#/components/schemas/TextEnableTollFreeNumbersLoaInfoCommon"},"directLoaInfo":{"$ref":"#/components/schemas/DirectLoaInfo"}},"required":["directLoaInfo"]}},"components/schemas/TextEnableTollFreeNumbersResellerLoaInfoRequest":{"id":"components/schemas/TextEnableTollFreeNumbersResellerLoaInfoRequest","kind":"json-schema","title":"TextEnableTollFreeNumbersResellerLoaInfoRequest","data":{"type":"object","properties":{"allOf":{"$ref":"#/components/schemas/TextEnableTollFreeNumbersLoaInfoCommon"},"resellerLoaInfo":{"$ref":"#/components/schemas/ResellerLoaInfo"}},"required":["resellerLoaInfo"]}},"components/schemas/HostingOrderNumber_PlatformProvisioning":{"id":"components/schemas/HostingOrderNumber_PlatformProvisioning","kind":"json-schema","title":"HostingOrderNumber_PlatformProvisioning","data":{"description":"An object containing information related to the provisioning on the platform.","type":"object","properties":{"servicePlanId":{"type":"string","description":"The service plan ID to which the hosting order number is associated.","example":"YOUR_service_plan_id"},"state":{"$ref":"#/components/schemas/State"}}}},"components/schemas/HostingOrderReport":{"id":"components/schemas/HostingOrderReport","kind":"json-schema","title":"HostingOrderReport","data":{"type":"object","properties":{"total":{"type":"integer","format":"int32"},"osrUpdated":{"type":"integer","format":"int32"},"smsProvisioned":{"type":"integer","format":"int32"},"addedToCampaign":{"type":"integer","format":"int32"},"ongoingManualAction":{"type":"integer","format":"int32"}}}},"components/schemas/ImportNumbersRequest":{"id":"components/schemas/ImportNumbersRequest","kind":"json-schema","title":"ImportNumbersRequest","data":{"required":["regionCode","numbers","servicePlanId"],"type":"object","properties":{"projectId":{"type":"string","description":"The ID of the project to which the import request is associated.","example":"YOUR_project_id"},"displayName":{"type":"string","description":"The optional display name of the import request.","example":"MyImportRequest"},"regionCode":{"type":"string","description":"The region code for the import request.","example":"US"},"numbers":{"type":"array","description":"An array of all the phone numbers associated with the import request.","items":{"type":"string","example":"+12025550134"}},"servicePlanId":{"type":"string","description":"The ID of the service plan to which the import request is associated.","example":"YOUR_service_plan_id"},"campaignId":{"type":"string","description":"The ID of the campaign to which the request is associated.","example":"YOUR_campaign_id"},"callbackUrl":{"type":"string","description":"The callback URL to be called for import numbers updates"},"migrateToSinchTmo":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a number is assigned to another aggregator in T-Mobile's platform, then T-Mobile will give an error code 60135 indicating that number needs to be “migrated” from previous aggregator to Sinch. This “migration” requires provisioning of number by setting this flag named to true for successful number linking process."},"children":[]}]}]}]}}}},"components/schemas/ListHostingOrderNumbersResponse":{"id":"components/schemas/ListHostingOrderNumbersResponse","kind":"json-schema","title":"ListHostingOrderNumbersResponse","data":{"type":"object","properties":{"numbers":{"type":"array","items":{"$ref":"#/components/schemas/HostingOrderNumber"}},"nextPageToken":{"type":"string"},"totalSize":{"type":"integer","format":"int32"}}}},"components/schemas/ListHostingOrdersResponse":{"id":"components/schemas/ListHostingOrdersResponse","kind":"json-schema","title":"ListHostingOrdersResponse","data":{"type":"object","properties":{"hostingOrders":{"type":"array","items":{"$ref":"#/components/schemas/HostingOrder"}},"nextPageToken":{"type":"string"},"totalSize":{"type":"integer","format":"int32"}}}},"components/schemas/ResellerLoaInfo":{"id":"components/schemas/ResellerLoaInfo","kind":"json-schema","title":"ResellerLoaInfo","data":{"description":"Letter of Authorization for resellers.","required":["businessName","authorisedPerson","address","currentVoiceCarrier"],"type":"object","properties":{"businessName":{"type":"string","description":"The name of the business.","example":"Acme, Inc."},"authorisedPerson":{"$ref":"#/components/schemas/AuthorizedPerson"},"address":{"$ref":"#/components/schemas/Address"},"currentVoiceCarrier":{"type":"string","description":"The current carrier you are using for voice services for the number you want to host on Sinch.","example":"TMO"}}}},"components/schemas/TextEnableInfo":{"id":"components/schemas/TextEnableInfo","kind":"json-schema","title":"TextEnableInfo","data":{"type":"object","properties":{"businessName":{"type":"string","description":"The name of the business.","example":"Acme, Inc."},"authorisedPerson":{"$ref":"#/components/schemas/AuthorizedPerson"},"address":{"$ref":"#/components/schemas/Address"},"serviceProvider":{"type":"string"},"currentVoiceCarrier":{"type":"string","description":"The current carrier you are using for voice services for the number you want to host on Sinch.","example":"TMO"},"nnid":{"type":"string","description":"The Net Number ID for the number you want to host on Sinch."},"loaType":{"description":"The type of the letter of authorization.","type":"string","format":"enum","enum":["Direct","Reseller"],"x-enumDescriptions":{"Direct":"If you are a direct Sinch customer.","Reseller":"If you are a Sinch partner or reseller."}}}}},"components/schemas/TextEnableNumbersRequest":{"id":"components/schemas/TextEnableNumbersRequest","kind":"json-schema","title":"TextEnableNumbersRequest","data":{"description":"A request to text enable the numbers in a hosting order.","required":["regionCode","numbers","servicePlanId"],"type":"object","properties":{"projectId":{"type":"string","description":"The ID of the project to which the hosting order is associated.","example":"YOUR_project_id"},"displayName":{"type":"string","description":"The optional display name of the hosting order.","example":"MyHostingOrder"},"regionCode":{"type":"string","description":"The region code for the hosting order.","example":"US"},"numbers":{"type":"array","description":"An array of all the phone numbers associated with the hosting order.","items":{"type":"string","example":"+12025550134"}},"nnid":{"type":"string","description":"Defaults to either Sinch NNID or what was originally configured on the customer account. Sinch encourages customers to use the Sinch NNID, but if you want to use another NNID, please contact your account manager."},"servicePlanId":{"type":"string","description":"The ID of the service plan to which the hosting order is associated.","example":"YOUR_service_plan_id"},"campaignId":{"type":"string","description":"The ID of the campaign to which the hosting order is associated.","example":"YOUR_campaign_id"},"directLoaInfo":{"$ref":"#/components/schemas/DirectLoaInfo"},"resellerLoaInfo":{"$ref":"#/components/schemas/ResellerLoaInfo"},"blanketLoaInfo":{"$ref":"#/components/schemas/BlanketLoaInfo"},"scheduledOsrUpdateTime":{"type":"string","format":"date-time","description":"The scheduled time for OSR to be updated."},"migrateToSinchTmo":{"type":"boolean","readOnly":true,"description":"Displays if a number is assigned to another aggregator in T-Mobile's platform, and requires migration from previous aggregator to Sinch."},"callbackUrl":{"type":"string","description":"The client's callback URL to be called for text enablement updates.","example":"https://www.your-callback-server.com/callback"}}}},"components/schemas/BatchCreateQualifiedNumbersRequest":{"id":"components/schemas/BatchCreateQualifiedNumbersRequest","kind":"json-schema","title":"BatchCreateQualifiedNumbersRequest","data":{"required":["phoneNumbers"],"type":"object","properties":{"phoneNumbers":{"type":"array","items":{"type":"string","example":"+12345612345"}}},"description":"The phone numbers you want to qualify."}},"components/schemas/BatchCreateQualifiedNumbersResponse":{"id":"components/schemas/BatchCreateQualifiedNumbersResponse","kind":"json-schema","title":"BatchCreateQualifiedNumbersResponse","data":{"type":"object","properties":{"qualifiedNumbers":{"type":"array","items":{"$ref":"#/components/schemas/QualifiedNumber"}}}}},"components/schemas/ListQualifiedNumber":{"id":"components/schemas/ListQualifiedNumber","kind":"json-schema","title":"ListQualifiedNumber","data":{"type":"object","properties":{"qualifiedNumbers":{"type":"array","items":{"$ref":"#/components/schemas/QualifiedNumber"}},"nextPageToken":{"type":"string"},"totalSize":{"type":"integer","format":"int32"}}}},"components/schemas/QualifiedNumber":{"id":"components/schemas/QualifiedNumber","kind":"json-schema","title":"QualifiedNumber","data":{"type":"object","properties":{"phoneNumber":{"type":"string","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 e.164 format with leading +."},"children":[]}]}]}],"example":"+12025550134"},"projectId":{"type":"string","description":"The ID of the project to which the number belongs.","example":"abcd12ef-ab12-ab12-bc34-abcdef123456"},"regionCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of the phone number. Example US or CA.","example":"US"},"globalProcessState":{"type":"string","format":"enum","enum":["GLOBAL_PROCESS_STATE_UNSPECIFIED","GLOBAL_PROCESS_STATE_ELIGIBLE_CHECK_PENDING","GLOBAL_PROCESS_STATE_ELIGIBLE","GLOBAL_PROCESS_STATE_NOT_ELIGIBLE","GLOBAL_PROCESS_STATE_VERIFICATION_PENDING","GLOBAL_PROCESS_STATE_VERIFICATION_FAILED","GLOBAL_PROCESS_STATE_VERIFICATION_BLOCKED","GLOBAL_PROCESS_STATE_VERIFIED","GLOBAL_PROCESS_STATE_HOSTING_IN_PROGRESS","GLOBAL_PROCESS_STATE_HOSTING_DONE","GLOBAL_PROCESS_STATE_HOSTING_FAILED"],"x-enumDescriptions":{"GLOBAL_PROCESS_STATE_UNSPECIFIED":"The state is unspecified.","GLOBAL_PROCESS_STATE_ELIGIBLE_CHECK_PENDING":"The check for eligibility is pending.","GLOBAL_PROCESS_STATE_ELIGIBLE":"The state is eligible.","GLOBAL_PROCESS_STATE_NOT_ELIGIBLE":"The state is not eligible.","GLOBAL_PROCESS_STATE_VERIFICATION_PENDING":"The state verification is pending.","GLOBAL_PROCESS_STATE_VERIFICATION_FAILED":"The state verification failed.","GLOBAL_PROCESS_STATE_VERIFICATION_BLOCKED":"The state verification is blocked.","GLOBAL_PROCESS_STATE_VERIFIED":"The state is verified.","GLOBAL_PROCESS_STATE_HOSTING_IN_PROGRESS":"Hosting process is in progress.","GLOBAL_PROCESS_STATE_HOSTING_DONE":"Hosting process is done.","GLOBAL_PROCESS_STATE_HOSTING_FAILED":"Hosting process failed."},"description":"The global processing state of the qualified number."},"osrEligibility":{"$ref":"#/components/schemas/QualifiedNumber_OsrEligibilityDetails"},"ownershipVerification":{"$ref":"#/components/schemas/QualifiedNumber_OwnershipVerificationDetails"},"hostedNumber":{"$ref":"#/components/schemas/QualifiedNumber_HostedNumberDetails"},"createdTime":{"description":"The date and time the hosting order was created.","type":"string","format":"date-time"},"updatedTime":{"description":"The date and time the hosting order was last updated.","type":"string","format":"date-time"}}}},"components/schemas/QualifiedNumber_HostedNumberDetails":{"id":"components/schemas/QualifiedNumber_HostedNumberDetails","kind":"json-schema","title":"QualifiedNumber_HostedNumberDetails","data":{"description":"Details about the hosting status of a number, including any errors if available.","type":"object","properties":{"status":{"type":"integer","description":"The status of the hosting details.","format":"enum","enum":[0,1,2],"x-enumDescriptions":{"0":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HOSTING_STATUS_UNSPECIFIED"},"children":[]}]}]}],"1":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HOSTING_STATUS_HOSTED"},"children":[]}]}]}],"2":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HOSTING_STATUS_FAILED"},"children":[]}]}]}]}},"error":{"type":"string","description":"The description of the hosting status error."}}}},"components/schemas/QualifiedNumber_OsrEligibilityDetails":{"id":"components/schemas/QualifiedNumber_OsrEligibilityDetails","kind":"json-schema","title":"QualifiedNumber_OsrEligibilityDetails","data":{"description":"Details about the OSR eligibility, including the status of the OSR update, and the error if available.","type":"object","properties":{"status":{"$ref":"#/components/schemas/State"},"error":{"type":"string"}}}},"components/schemas/QualifiedNumber_OwnershipVerificationDetails":{"id":"components/schemas/QualifiedNumber_OwnershipVerificationDetails","kind":"json-schema","title":"QualifiedNumber_OwnershipVerificationDetails","data":{"description":"Details about the ownership verification, including the status of the verification process and any error if available.","type":"object","properties":{"status":{"$ref":"#/components/schemas/State"},"error":{"type":"string"}}}},"components/schemas/TextEnableResponse":{"id":"components/schemas/TextEnableResponse","kind":"json-schema","title":"TextEnableResponse","data":{"type":"object","properties":{"hostingOrderId":{"type":"string","description":"The ID of the hosting order."}}}},"components/schemas/VerifyVoiceChallengeRequest":{"id":"components/schemas/VerifyVoiceChallengeRequest","kind":"json-schema","title":"VerifyVoiceChallengeRequest","data":{"required":["code"],"type":"object","properties":{"code":{"type":"string","example":"1234"}}}},"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":"The HMAC secret to be updated for the specified project"}},"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","properties":{"resourceType":{"type":"string","description":"The type of the resource.","enum":["IMPORTED_NUMBER","HOSTING_ORDER_NUMBER"],"x-enumDescriptions":{"IMPORTED_NUMBER":"Numbers imported individually or previously imported successfully via hosting orders but later updated.","HOSTING_ORDER_NUMBER":"Numbers that are imported as part of a hosting order."},"example":"IMPORTED_NUMBER"},"eventType":{"type":"string","description":"The type of the event.","enum":["PROVISIONING_TO_SMS_PLATFORM","DEPROVISIONING_TO_SMS_PLATFORM","LINK_TO_10DLC_CAMPAIGN","UNLINK_TO_10DLC_CAMPAIGN","HOSTING_PROCESS","OSR_UPDATE","DELETE"],"x-enumDescriptions":{"PROVISIONING_TO_SMS_PLATFORM":"An event that occurs when a number is linked to a Service Plan ID.","DEPROVISIONING_TO_SMS_PLATFORM":"An event that occurs when a number is unlinked from a Service Plan ID.","LINK_TO_10DLC_CAMPAIGN":"An event that occurs when a number is linked to a Campaign.","UNLINK_TO_10DLC_CAMPAIGN":"An event that occurs when a number is unlinked from a Campaign.","HOSTING_PROCESS":"An event that indicates the success or failure of a number's hosting process.","OSR_UPDATE":"An event that occurs when an OSR update is performed for a number.","DELETE":"An event that occurs when a number is deleted."},"example":"LINK_TO_10DLC_CAMPAIGN"},"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 in ISO 8601 format (UTC).","format":"date-time","example":"2023-06-06T07:45:27.785357Z"},"projectId":{"type":"string","description":"The ID of the project to which the event belongs.","example":"abcd12ef-ab12-ab12-bc34-abcdef123456"},"resourceId":{"type":"string","description":"The unique identifier of the resource, depending on the resource type. For example, a phone number, a hosting order ID, or a brand ID.","example":"+12345612345"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the event. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCEEDED"},"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":[]}]}]}],"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."}}}}},"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":"An invalid argument error code."}},"message":{"type":"string"},"status":{"type":"string","enum":["INVALID_ARGUMENT"],"x-enumDescriptions":{"INVALID_ARGUMENT":"An invalid argument error."}},"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":"A bad request error."}},"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/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":"A not found error code."}},"message":{"type":"string"},"status":{"type":"string","enum":["NOT_FOUND"],"x-enumDescriptions":{"NOT_FOUND":"Could not find the resource."}},"details":{"type":"array","items":{"type":"object"}}}}}}},"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":"An internal server error code."}},"message":{"type":"string"},"status":{"type":"string","enum":["INTERNAL","UNKNOWN"],"x-enumDescriptions":{"INTERNAL":"Internal server error.","UNKNOWN":"Unknown error."}},"details":{"type":"array","items":{"type":"object"}}}}}}},"schema_675":{"kind":"json-schema","data":{"type":"string","example":"d1923022-5199-4bb3-a513-c47b3a656bc5"},"id":"schema_675"},"schema_676":{"kind":"json-schema","data":{"type":"string","example":"US"},"id":"schema_676"},"schema_677":{"kind":"json-schema","data":{"type":"string","enum":["HOSTING_ORDER_STATE_UNSPECIFIED","DRAFT","SUBMITTED","WAITING_FOR_LOA_SIGNATURE","IN_PROGRESS","COMPLETED","REJECTED"],"x-enumDescriptions":{"HOSTING_ORDER_STATE_UNSPECIFIED":"State is unspecified.","DRAFT":"Hosting order is a draft.","SUBMITTED":"Hosting order has been submitted.","WAITING_FOR_LOA_SIGNATURE":"Hosting order is waiting for the LoA signature.","IN_PROGRESS":"Hosting order is in progress.","COMPLETED":"Hosting order is completed.","REJECTED":"Hosting order is rejected."}},"id":"schema_677"},"schema_678":{"kind":"json-schema","data":{"type":"string","enum":["HOSTING_ORDER_TYPE_UNSPECIFIED","IMPORT","TYPE_TEXT_ENABLE"],"x-enumDescriptions":{"HOSTING_ORDER_TYPE_UNSPECIFIED":"Type is unspecified.","IMPORT":"Type is importing numbers.","TYPE_TEXT_ENABLE":"Type is text enabling numbers."}},"id":"schema_678"},"schema_679":{"kind":"json-schema","data":{"type":"string","example":"324e4567-e89b-12d3-a456-426614174000"},"id":"schema_679"},"schema_680":{"kind":"json-schema","data":{"type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"id":"schema_680"},"schema_681":{"kind":"json-schema","data":{"type":"string","enum":["createdTime","updatedTime"],"x-enumDescriptions":{"createdTime":"Order by the time the hosting order was created.","updatedTime":"Order by the time the hosting order was last updated."}},"id":"schema_681"},"schema_682":{"kind":"json-schema","data":{"type":"string","example":"C2VNYXJrEg4KDCsxMjAxMjI2MzUyOQ=="},"id":"schema_682"},"schema_683":{"kind":"json-schema","data":{"type":"integer","example":20},"id":"schema_683"},"schema_684":{"kind":"json-schema","data":{"type":"string","example":"01arz3ndektsv4rrffq69g5fav"},"id":"schema_684"},"schema_685":{"kind":"json-schema","data":{"$ref":"#/components/schemas/State"},"id":"schema_685"},"schema_686":{"kind":"json-schema","data":{"type":"string","example":"+12025550134"},"id":"schema_686"},"schema_687":{"kind":"json-schema","data":{"type":"string","example":"+1732"},"id":"schema_687"},"schema_688":{"kind":"json-schema","data":{"type":"string","enum":["START","CONTAIN","END"],"x-enumDescriptions":{"START":"Number starts with specified pattern.","CONTAIN":"Number contains specified pattern.","END":"Number ends with specified pattern."},"example":"START"},"id":"schema_688"},"schema_689":{"kind":"json-schema","data":{"type":"string","enum":["GLOBAL_PROCESS_STATE_ELIGIBLE_CHECK_PENDING","GLOBAL_PROCESS_STATE_ELIGIBLE","GLOBAL_PROCESS_STATE_NOT_ELIGIBLE","GLOBAL_PROCESS_STATE_VERIFICATION_PENDING","GLOBAL_PROCESS_STATE_VERIFICATION_FAILED","GLOBAL_PROCESS_STATE_VERIFICATION_BLOCKED","GLOBAL_PROCESS_STATE_VERIFIED","GLOBAL_PROCESS_STATE_HOSTING_IN_PROGRESS","GLOBAL_PROCESS_STATE_HOSTING_DONE","GLOBAL_PROCESS_STATE_HOSTING_FAILED","GLOBAL_PROCESS_STATE_UNSPECIFIED"],"x-enumDescriptions":{"GLOBAL_PROCESS_STATE_UNSPECIFIED":"The state is unspecified.","GLOBAL_PROCESS_STATE_ELIGIBLE_CHECK_PENDING":"The check for eligibility is pending.","GLOBAL_PROCESS_STATE_ELIGIBLE":"The state is eligible.","GLOBAL_PROCESS_STATE_NOT_ELIGIBLE":"The state is not eligible.","GLOBAL_PROCESS_STATE_VERIFICATION_PENDING":"The state verification is pending.","GLOBAL_PROCESS_STATE_VERIFICATION_FAILED":"The state verification failed.","GLOBAL_PROCESS_STATE_VERIFICATION_BLOCKED":"The state verification is blocked.","GLOBAL_PROCESS_STATE_VERIFIED":"The state is verified.","GLOBAL_PROCESS_STATE_HOSTING_IN_PROGRESS":"Hosting process is in progress.","GLOBAL_PROCESS_STATE_HOSTING_DONE":"Hosting process is done.","GLOBAL_PROCESS_STATE_HOSTING_FAILED":"Hosting process failed."},"example":"GLOBAL_PROCESS_STATE_HOSTING_IN_PROGRESS"},"id":"schema_689"}},"exampleStore":{"components/examples/hostingOrderReportResponse":{"id":"components/examples/hostingOrderReportResponse","value":{"total":1,"osrUpdated":1,"smsProvisioned":1,"addedToCampaign":1},"summary":"A hosting order report response example"},"components/examples/textEnableTollFreeNumbers":{"id":"components/examples/textEnableTollFreeNumbers","value":{"regionCode":"US","numbers":["+18335870229","+18339460473"],"servicePlanId":"07d6c2621f364b68856fe4938b7bb78f","callbackUrl":"https://www.your-callback-server.com/callback","directLoaInfo":{"authorisedPerson":{"firstName":"John","lastName":"Smith","email":"email@domain.com"},"address":{"buildingNumber":"2433","street":"Vesta Drive","city":"Chicago","state":"IL","postalCode":"60647","country":"US"},"currentVoiceCarrier":"Verizon","scheduledZipwhipProvisioningTime":"2023-01-13T14:34:40.968Z","migrateToSinchTmo":true}},"summary":"Create a new order to text enable Toll Free numbers in the given project"},"components/examples/invalidServicePlanId":{"id":"components/examples/invalidServicePlanId","value":{"code":"400","message":"Invalid service_plan_id {servicePlanId}","status":"INVALID_ARGUMENT","details":[{"type":"BadRequest","fieldViolations":[{"field":"smsConfiguration.servicePlanId","description":"Invalid servicePlanId"}]}]},"summary":"Invalid servicePlanId"},"components/examples/hostingOrderResponse":{"id":"components/examples/hostingOrderResponse","value":{"projectId":"d1923022-5199-4bb3-a513-c47n7a656bc5","hostingOrderId":"01arz3nhyrtsv4rrffq69g5fav","displayName":"Hosting order with campaignId, nnid and smsAppId","regionCode":"US","state":"SUBMITTED","type":"TYPE_TEXT_ENABLE","createdTime":"2023-01-12T14:34:40.968Z","updatedTime":"2023-01-12T14:34:40.968Z","scheduledOsrUpdateTime":"2023-01-13T14:34:40.968Z","servicePlanId":"16e5c8d2odc842bda9a1b90e1673c174","campaignId":"C3O84GA","migrateToSinchTmo":true,"callbackUrl":"https://www.your-callback-server.com/callback","hostingOrderInfo":{"businessName":"Sinch AB","authorisedPerson":{"firstName":"John","lastName":"Smith","email":"email@domain.com"},"address":{"buildingNumber":"2433","street":"Vesta Drive","city":"Chicago","state":"IL","postalCode":"60647","country":"US"},"serviceProvider":"Sinch America Inc.","currentVoiceCarrier":"Verizon","nnid":"104029","loaType":"DIRECT"}},"summary":"A hosting order response example"},"components/examples/blanketLoaTextEnable":{"id":"components/examples/blanketLoaTextEnable","value":{"regionCode":"US","numbers":["+17724295286","+17724295287"],"servicePlanId":"07d6c2621f364b68856fe4938b7bb78f","campaignId":"C3O8OGA","callbackUrl":"https://www.your-callback-server.com/callback","blanketLoaInfo":{},"scheduledOsrUpdateTime":"2023-01-13T14:34:40.968Z","migrateToSinchTmo":true},"summary":"Create a new order to text enable numbers with a blanket LOA"},"components/examples/textEnableNumbers":{"id":"components/examples/textEnableNumbers","value":{"regionCode":"US","numbers":["+17724295286","+17724295287"],"servicePlanId":"07d6c2621f364b68856fe4938b7bb78f","campaignId":"C3O8OGA","callbackUrl":"https://www.your-callback-server.com/callback","directLoaInfo":{"authorisedPerson":{"firstName":"John","lastName":"Smith","email":"email@domain.com"},"address":{"buildingNumber":"2433","street":"Vesta Drive","city":"Chicago","state":"IL","postalCode":"60647","country":"US"},"currentVoiceCarrier":"Verizon"},"scheduledOsrUpdateTime":"2023-01-13T14:34:40.968Z","migrateToSinchTmo":true},"summary":"Create a new order to text enable numbers in the given project"},"components/examples/importNumbersHostingOrderRequest":{"id":"components/examples/importNumbersHostingOrderRequest","value":{"displayName":"Import numbers order","regionCode":"US","numbers":["+17724295286","+17724295287"],"servicePlanId":"07d6c2621f364b68856fe4938b7bb78f","campaignId":"C3O8OGA","callbackUrl":"https://www.your-callback-server.com/callback","migrateToSinchTmo":true},"summary":"Create a new order to import numbers in the given project"},"components/examples/importNumbersHostingOrderResponse":{"id":"components/examples/importNumbersHostingOrderResponse","value":{"projectId":"d1923022-5199-4bb3-a513-c47n7a656bc5","hostingOrderId":"01arz3nhyrtsv4rrffq69g5fav","displayName":"Hosting order with campaignId and smsAppId","regionCode":"US","state":"SUBMITTED","type":"IMPORT","createdTime":"2023-01-12T14:34:40.968Z","updatedTime":"2023-01-12T14:34:40.968Z","servicePlanId":"16e5c8d2odc842bda9a1b90e1673c174","campaignId":"C3O84GA","migrateToSinchTmo":true,"callbackUrl":"https://www.your-callback-server.com/callback","numberImport":"{}"},"summary":"A import numbers hosting order response example"},"paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}/get/responses/200/content/application~1json/example":{"value":{"projectId":"d1923022-5199-4bb3-a513-c47n7a656bc5","hostingOrderId":"01arz3nhyrtsv4rrffq69g5fav","displayName":"Hosting order with campaignId, nnid and smsAppId","regionCode":"US","state":"SUBMITTED","type":"IMPORT","createdTime":"2023-01-12T14:34:40.968Z","updatedTime":"2023-01-12T14:34:40.968Z","scheduledOsrUpdateTime":"2023-01-13T14:34:40.968Z","servicePlanId":"16e5c8d2odc842bda9a1b90e1673c174","campaignId":"C3O84GA","migrateToSinchTmo":true,"callbackUrl":"https://www.your-callback-server.com/callback","hostingOrderInfo":{"businessName":"Sinch AB","authorisedPerson":{"firstName":"John","lastName":"Smith","email":"email@domain.com"},"address":{"buildingNumber":"2433","street":"Vesta Drive","city":"Chicago","state":"IL","postalCode":"60647","country":"US"},"serviceProvider":"Sinch America Inc.","currentVoiceCarrier":"Verizon","nnid":"104029","loaType":"DIRECT"}},"id":"paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}/get/responses/200/content/application~1json/example"},"paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}~1report/get/responses/200/content/application~1json/examples/hostingOrderReportResponse":{"value":{"total":1,"osrUpdated":1,"smsProvisioned":1,"addedToCampaign":1},"key":"hostingOrderReportResponse","summary":"A hosting order report response example","id":"paths/~1v1~1projects~1{projectId}~1hostingOrders~1{hostingOrderId}~1report/get/responses/200/content/application~1json/examples/hostingOrderReportResponse"},"paths/~1v1~1projects~1{projectId}~1hostingOrders:importNumbers/post/requestBody/content/application~1json/examples/importNumbersRequest":{"value":{"displayName":"Import numbers order","regionCode":"US","numbers":["+17724295286","+17724295287"],"servicePlanId":"07d6c2621f364b68856fe4938b7bb78f","campaignId":"C3O8OGA","callbackUrl":"https://www.your-callback-server.com/callback","migrateToSinchTmo":true},"key":"importNumbersRequest","summary":"Create a new order to import numbers in the given project","id":"paths/~1v1~1projects~1{projectId}~1hostingOrders:importNumbers/post/requestBody/content/application~1json/examples/importNumbersRequest"},"paths/~1v1~1projects~1{projectId}~1hostingOrders:importNumbers/post/responses/200/content/application~1json/examples/hostingOrderResponse":{"value":{"projectId":"d1923022-5199-4bb3-a513-c47n7a656bc5","hostingOrderId":"01arz3nhyrtsv4rrffq69g5fav","displayName":"Hosting order with campaignId and smsAppId","regionCode":"US","state":"SUBMITTED","type":"IMPORT","createdTime":"2023-01-12T14:34:40.968Z","updatedTime":"2023-01-12T14:34:40.968Z","servicePlanId":"16e5c8d2odc842bda9a1b90e1673c174","campaignId":"C3O84GA","migrateToSinchTmo":true,"callbackUrl":"https://www.your-callback-server.com/callback","numberImport":"{}"},"key":"hostingOrderResponse","summary":"A import numbers hosting order response example","id":"paths/~1v1~1projects~1{projectId}~1hostingOrders:importNumbers/post/responses/200/content/application~1json/examples/hostingOrderResponse"},"paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers":{"value":{"regionCode":"US","numbers":["+17724295286","+17724295287"],"servicePlanId":"07d6c2621f364b68856fe4938b7bb78f","campaignId":"C3O8OGA","callbackUrl":"https://www.your-callback-server.com/callback","directLoaInfo":{"authorisedPerson":{"firstName":"John","lastName":"Smith","email":"email@domain.com"},"address":{"buildingNumber":"2433","street":"Vesta Drive","city":"Chicago","state":"IL","postalCode":"60647","country":"US"},"currentVoiceCarrier":"Verizon"},"scheduledOsrUpdateTime":"2023-01-13T14:34:40.968Z","migrateToSinchTmo":true},"key":"textEnableNumbers","summary":"Create a new order to text enable numbers in the given project","id":"paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers"},"paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/requestBody/content/application~1json/examples/blanketLoa":{"value":{"regionCode":"US","numbers":["+17724295286","+17724295287"],"servicePlanId":"07d6c2621f364b68856fe4938b7bb78f","campaignId":"C3O8OGA","callbackUrl":"https://www.your-callback-server.com/callback","blanketLoaInfo":{},"scheduledOsrUpdateTime":"2023-01-13T14:34:40.968Z","migrateToSinchTmo":true},"key":"blanketLoa","summary":"Create a new order to text enable numbers with a blanket LOA","id":"paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/requestBody/content/application~1json/examples/blanketLoa"},"paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/responses/200/content/application~1json/examples/hostingOrderTextEnableResponse":{"value":{"projectId":"d1923022-5199-4bb3-a513-c47n7a656bc5","hostingOrderId":"01arz3nhyrtsv4rrffq69g5fav","displayName":"Hosting order with campaignId, nnid and smsAppId","regionCode":"US","state":"SUBMITTED","type":"TYPE_TEXT_ENABLE","createdTime":"2023-01-12T14:34:40.968Z","updatedTime":"2023-01-12T14:34:40.968Z","scheduledOsrUpdateTime":"2023-01-13T14:34:40.968Z","servicePlanId":"16e5c8d2odc842bda9a1b90e1673c174","campaignId":"C3O84GA","migrateToSinchTmo":true,"callbackUrl":"https://www.your-callback-server.com/callback","hostingOrderInfo":{"businessName":"Sinch AB","authorisedPerson":{"firstName":"John","lastName":"Smith","email":"email@domain.com"},"address":{"buildingNumber":"2433","street":"Vesta Drive","city":"Chicago","state":"IL","postalCode":"60647","country":"US"},"serviceProvider":"Sinch America Inc.","currentVoiceCarrier":"Verizon","nnid":"104029","loaType":"DIRECT"}},"key":"hostingOrderTextEnableResponse","summary":"A hosting order response example","id":"paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/responses/200/content/application~1json/examples/hostingOrderTextEnableResponse"},"paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/responses/200/content/application~1json/examples/hostingOrderImportNumbersResponse":{"value":{"projectId":"d1923022-5199-4bb3-a513-c47n7a656bc5","hostingOrderId":"01arz3nhyrtsv4rrffq69g5fav","displayName":"Hosting order with campaignId and smsAppId","regionCode":"US","state":"SUBMITTED","type":"IMPORT","createdTime":"2023-01-12T14:34:40.968Z","updatedTime":"2023-01-12T14:34:40.968Z","servicePlanId":"16e5c8d2odc842bda9a1b90e1673c174","campaignId":"C3O84GA","migrateToSinchTmo":true,"callbackUrl":"https://www.your-callback-server.com/callback","numberImport":"{}"},"key":"hostingOrderImportNumbersResponse","summary":"A import numbers hosting order response example","id":"paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/responses/200/content/application~1json/examples/hostingOrderImportNumbersResponse"},"paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/responses/400/content/application~1json/examples/invalidServicePlanId":{"value":{"code":"400","message":"Invalid service_plan_id {servicePlanId}","status":"INVALID_ARGUMENT","details":[{"type":"BadRequest","fieldViolations":[{"field":"smsConfiguration.servicePlanId","description":"Invalid servicePlanId"}]}]},"key":"invalidServicePlanId","summary":"Invalid servicePlanId","id":"paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableNumbers/post/responses/400/content/application~1json/examples/invalidServicePlanId"},"paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers":{"value":{"regionCode":"US","numbers":["+18335870229","+18339460473"],"servicePlanId":"07d6c2621f364b68856fe4938b7bb78f","callbackUrl":"https://www.your-callback-server.com/callback","directLoaInfo":{"authorisedPerson":{"firstName":"John","lastName":"Smith","email":"email@domain.com"},"address":{"buildingNumber":"2433","street":"Vesta Drive","city":"Chicago","state":"IL","postalCode":"60647","country":"US"},"currentVoiceCarrier":"Verizon","scheduledZipwhipProvisioningTime":"2023-01-13T14:34:40.968Z","migrateToSinchTmo":true}},"key":"textEnableNumbers","summary":"Create a new order to text enable Toll Free numbers in the given project","id":"paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers"},"paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderTextEnableResponse":{"value":{"projectId":"d1923022-5199-4bb3-a513-c47n7a656bc5","hostingOrderId":"01arz3nhyrtsv4rrffq69g5fav","displayName":"Hosting order with campaignId, nnid and smsAppId","regionCode":"US","state":"SUBMITTED","type":"TYPE_TEXT_ENABLE","createdTime":"2023-01-12T14:34:40.968Z","updatedTime":"2023-01-12T14:34:40.968Z","scheduledOsrUpdateTime":"2023-01-13T14:34:40.968Z","servicePlanId":"16e5c8d2odc842bda9a1b90e1673c174","campaignId":"C3O84GA","migrateToSinchTmo":true,"callbackUrl":"https://www.your-callback-server.com/callback","hostingOrderInfo":{"businessName":"Sinch AB","authorisedPerson":{"firstName":"John","lastName":"Smith","email":"email@domain.com"},"address":{"buildingNumber":"2433","street":"Vesta Drive","city":"Chicago","state":"IL","postalCode":"60647","country":"US"},"serviceProvider":"Sinch America Inc.","currentVoiceCarrier":"Verizon","nnid":"104029","loaType":"DIRECT"}},"key":"hostingOrderTextEnableResponse","summary":"A hosting order response example","id":"paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderTextEnableResponse"},"paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderImportNumbersResponse":{"value":{"projectId":"d1923022-5199-4bb3-a513-c47n7a656bc5","hostingOrderId":"01arz3nhyrtsv4rrffq69g5fav","displayName":"Hosting order with campaignId and smsAppId","regionCode":"US","state":"SUBMITTED","type":"IMPORT","createdTime":"2023-01-12T14:34:40.968Z","updatedTime":"2023-01-12T14:34:40.968Z","servicePlanId":"16e5c8d2odc842bda9a1b90e1673c174","campaignId":"C3O84GA","migrateToSinchTmo":true,"callbackUrl":"https://www.your-callback-server.com/callback","numberImport":"{}"},"key":"hostingOrderImportNumbersResponse","summary":"A import numbers hosting order response example","id":"paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderImportNumbersResponse"},"paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/responses/400/content/application~1json/examples/invalidServicePlanId":{"value":{"code":"400","message":"Invalid service_plan_id {servicePlanId}","status":"INVALID_ARGUMENT","details":[{"type":"BadRequest","fieldViolations":[{"field":"smsConfiguration.servicePlanId","description":"Invalid servicePlanId"}]}]},"key":"invalidServicePlanId","summary":"Invalid servicePlanId","id":"paths/~1v1~1projects~1{projectId}~1hostingOrders:textEnableTollFreeNumbers/post/responses/400/content/application~1json/examples/invalidServicePlanId"},"paths/~1v1~1projects~1{projectId}~1importedNumbers/post/requestBody/content/application~1json/examples/ProvisioningExample":{"value":{"regionCode":"US","smsConfiguration":{"servicePlanId":"YOUR_service_plan_id","campaignId":"YOUR_campaign_id","migrateToSinchTmo":true},"phoneNumber":"+11234567890","displayName":"MyPhoneNumber","callbackUrl":"https://www.your-callback-server.com/callback"},"key":"ProvisioningExample","summary":"Importing a qualified number","id":"paths/~1v1~1projects~1{projectId}~1importedNumbers/post/requestBody/content/application~1json/examples/ProvisioningExample"},"paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/UnlinkNumber":{"value":{"displayName":"My Display Name","smsConfiguration":{"servicePlanId":"","campaignId":""},"callbackUrl":"https://www.your-callback-server.com/callback"},"key":"UnlinkNumber","summary":"Unlink a number with a campaign and service plan","id":"paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/UnlinkNumber"},"paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/LinkNumber":{"value":{"displayName":"My Display Name","smsConfiguration":{"servicePlanId":"YOUR_service_plan_id","campaignId":"YOUR_campaign_id"},"callbackUrl":"https://www.your-callback-server.com/callback"},"key":"LinkNumber","summary":"Link a number from a campaign and service plan","id":"paths/~1v1~1projects~1{projectId}~1importedNumbers~1{phoneNumber}/patch/requestBody/content/application~1json/examples/LinkNumber"},"paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableNumbers/post/requestBody/content/application~1json/examples/directLOAExample":{"value":{"regionCode":"US","numbers":["+12025550134"],"servicePlanId":"YOUR_service_plan_id","campaignId":"YOUR_campaign_id","directLoaInfo":{"authorisedPerson":{"firstName":"John","lastName":"Doe","email":"john.doe@email.com"},"address":{"buildingNumber":"1234","street":"Main St","city":"NYC","state":"NY","postalCode":"01002","country":"US"},"currentVoiceCarrier":"Verizon"},"scheduledOsrUpdateTime":"2023-01-13T14:34:40.968Z","migrateToSinchTmo":true},"key":"directLOAExample","summary":"Direct customer LOA","id":"paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableNumbers/post/requestBody/content/application~1json/examples/directLOAExample"},"paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableNumbers/post/requestBody/content/application~1json/examples/resellerLOAExample":{"value":{"regionCode":"US","numbers":["+12025550134"],"servicePlanId":"YOUR_service_plan_id","campaignId":"YOUR_campaign_id","resellerLoaInfo":{"businessName":"Acme, Inc.","authorisedPerson":{"firstName":"John","lastName":"Doe","email":"john.doe@email.com"},"address":{"buildingNumber":"1234","street":"Main St","city":"NYC","state":"NY","postalCode":"01002","country":"US"},"currentVoiceCarrier":"Verizon"},"scheduledOsrUpdateTime":"2023-01-13T14:34:40.968Z","migrateToSinchTmo":true},"key":"resellerLOAExample","summary":"Reseller LOA","id":"paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableNumbers/post/requestBody/content/application~1json/examples/resellerLOAExample"},"paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers":{"value":{"regionCode":"US","numbers":["+18335870229","+18339460473"],"servicePlanId":"07d6c2621f364b68856fe4938b7bb78f","callbackUrl":"https://www.your-callback-server.com/callback","directLoaInfo":{"authorisedPerson":{"firstName":"John","lastName":"Smith","email":"email@domain.com"},"address":{"buildingNumber":"2433","street":"Vesta Drive","city":"Chicago","state":"IL","postalCode":"60647","country":"US"},"currentVoiceCarrier":"Verizon","scheduledZipwhipProvisioningTime":"2023-01-13T14:34:40.968Z","migrateToSinchTmo":true}},"key":"textEnableNumbers","summary":"Create a new order to text enable Toll Free numbers in the given project","id":"paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/requestBody/content/application~1json/examples/textEnableNumbers"},"paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderTextEnableResponse":{"value":{"projectId":"d1923022-5199-4bb3-a513-c47n7a656bc5","hostingOrderId":"01arz3nhyrtsv4rrffq69g5fav","displayName":"Hosting order with campaignId, nnid and smsAppId","regionCode":"US","state":"SUBMITTED","type":"TYPE_TEXT_ENABLE","createdTime":"2023-01-12T14:34:40.968Z","updatedTime":"2023-01-12T14:34:40.968Z","scheduledOsrUpdateTime":"2023-01-13T14:34:40.968Z","servicePlanId":"16e5c8d2odc842bda9a1b90e1673c174","campaignId":"C3O84GA","migrateToSinchTmo":true,"callbackUrl":"https://www.your-callback-server.com/callback","hostingOrderInfo":{"businessName":"Sinch AB","authorisedPerson":{"firstName":"John","lastName":"Smith","email":"email@domain.com"},"address":{"buildingNumber":"2433","street":"Vesta Drive","city":"Chicago","state":"IL","postalCode":"60647","country":"US"},"serviceProvider":"Sinch America Inc.","currentVoiceCarrier":"Verizon","nnid":"104029","loaType":"DIRECT"}},"key":"hostingOrderTextEnableResponse","summary":"A hosting order response example","id":"paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderTextEnableResponse"},"paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderImportNumbersResponse":{"value":{"projectId":"d1923022-5199-4bb3-a513-c47n7a656bc5","hostingOrderId":"01arz3nhyrtsv4rrffq69g5fav","displayName":"Hosting order with campaignId and smsAppId","regionCode":"US","state":"SUBMITTED","type":"IMPORT","createdTime":"2023-01-12T14:34:40.968Z","updatedTime":"2023-01-12T14:34:40.968Z","servicePlanId":"16e5c8d2odc842bda9a1b90e1673c174","campaignId":"C3O84GA","migrateToSinchTmo":true,"callbackUrl":"https://www.your-callback-server.com/callback","numberImport":"{}"},"key":"hostingOrderImportNumbersResponse","summary":"A import numbers hosting order response example","id":"paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/responses/200/content/application~1json/examples/hostingOrderImportNumbersResponse"},"paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/responses/400/content/application~1json/examples/invalidServicePlanId":{"value":{"code":"400","message":"Invalid service_plan_id {servicePlanId}","status":"INVALID_ARGUMENT","details":[{"type":"BadRequest","fieldViolations":[{"field":"smsConfiguration.servicePlanId","description":"Invalid servicePlanId"}]}]},"key":"invalidServicePlanId","summary":"Invalid servicePlanId","id":"paths/~1v1~1projects~1{projectId}~1qualifiedNumbers:textEnableTollFreeNumbers/post/responses/400/content/application~1json/examples/invalidServicePlanId"}},"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://imported.numbers.api.sinch.com","description":"Global API"}],"specType":"openapi"},"options":{"sortRequiredPropsFirst":true,"mockServer":{"url":"/_mock/docs/numbers/api-reference/imported-hosting","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/numbers/api-reference/imported-hosting.json?download"},{"url":"/_bundle/docs/numbers/api-reference/imported-hosting.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Imported Numbers and Hosting Orders","description":"API for importing, hosting, and qualifying numbers to enable them for use with Sinch SMS text messaging services."}},"baseSlug":"/docs/numbers/api-reference/imported-hosting","routesMapping":{}}