openapi: 3.2.0
info:
  title: Numbers | Sinch Available Number API
  description: '# Overview


    The Numbers API enables you to search for, buy, view, and manage numbers.'
  version: 1.0.3
  contact:
    name: Support
    url: https://www.sinch.com
    email: Support@sinch.com
  license:
    name: MIT
    url: https://www.sinch.com/toc
servers:
- url: https://numbers.api.sinch.com
  description: Global API
security:
- Basic: []
- OAuth2.0: []
tags:
- name: Available Number
  description: You can use the Available Number API to search for numbers that are available to buy, in any region and of any number type, and to check a specific number's availability, price, and capabilities.
  x-displayName: Available Numbers
paths:
  /v1/projects/{projectId}/availableNumbers/{phoneNumber}:rent:
    parameters:
    - $ref: '#/components/parameters/projectId'
    - $ref: '#/components/parameters/phoneNumber'
    post:
      summary: Activate a new phone number
      description: '**Deprecated:** This endpoint is deprecated. It remains available for existing integrations, but new integrations should use the Number Order API, which supports numbers from all regions and of all number types. To order a specific number with a number order, use `numberOrderOption` in the "Create a number order" endpoint.


        Activate a phone number to use with SMS products, Voice products, or both.


        **Note:** This endpoint only supports US `LOCAL` numbers.


        You''ll use `smsConfiguration` to setup your number for SMS and `voiceConfiguration` for Voice. To setup for both, add both objects. See the dropdown menu (just under language selection) for code samples.


        Note: You cannot add both objects if you only need to configure one object. For example, if you only need to configure `smsConfiguration` for SMS messaging, do not add the `voiceConfiguration` object or it will result in an error.'
      operationId: NumberService_RentNumber
      deprecated: true
      requestBody:
        $ref: '#/components/requestBodies/RentNumberRequest'
      responses:
        '200':
          $ref: '#/components/responses/ActiveNumberResponse'
        '400':
          description: 400 Invalid Argument error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidArgument'
        '403':
          $ref: '#/components/responses/PermissionDenied'
        '404':
          description: 404 Not Found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '500':
          description: 500 Internal Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
      tags:
      - Available Number
      x-codeSamples:
      - lang: Java
        source: "/**\n * Sinch Java Snippet\n *\n * <p>This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n * <p>See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage numbers;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.numbers.api.v1.NumbersService;\nimport com.sinch.sdk.domains.numbers.models.v1.ActiveNumber;\nimport com.sinch.sdk.domains.numbers.models.v1.SmsConfiguration;\nimport com.sinch.sdk.domains.numbers.models.v1.request.AvailableNumberRentRequest;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class Rent {\n\n  private static final Logger LOGGER = Logger.getLogger(Rent.class.getName());\n\n  public static void main(String[] args) {\n\n    String projectId = Settings.getProjectId().orElse(\"MY_PROJECT_ID\");\n    String keyId = Settings.getKeyId().orElse(\"MY_KEY_ID\");\n    String keySecret = Settings.getKeySecret().orElse(\"MY_KEY_SECRET\");\n\n    String servicePlanIdToAssociateWithTheNumber =\n        Settings.getServicePlanId().orElse(\"MY_SERVICE_PLAN_ID\");\n\n    // Available numbers list can be retrieved by using list() function from available service, see\n    // the SearchAvailableSnippet or\n    // https://developers.sinch.com/docs/numbers/getting-started/java-sdk/searchavailable\n    String phoneNumberToBeRented = \"AVAILABLE_PHONE_NUMBER_TO_BE_RENTED\";\n\n    Configuration configuration =\n        Configuration.builder()\n            .setProjectId(projectId)\n            .setKeyId(keyId)\n            .setKeySecret(keySecret)\n            .build();\n\n    SinchClient client = new SinchClient(configuration);\n\n    NumbersService numbersService = client.numbers().v1();\n\n    SmsConfiguration smsConfiguration =\n        SmsConfiguration.builder().setServicePlanId(servicePlanIdToAssociateWithTheNumber).build();\n\n    AvailableNumberRentRequest parameters =\n        AvailableNumberRentRequest.builder().setSmsConfiguration(smsConfiguration).build();\n\n    ActiveNumber response = numbersService.rent(phoneNumberToBeRented, parameters);\n\n    LOGGER.info(String.format(\"Rented number: %s\", response));\n  }\n}\n"
      - lang: Node.js
        source: "/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';\n  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';\n  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';\n\n  // The available phone number to rent\n  const phoneNumber = 'PHONE_NUMBER';\n  // The service plan ID to associate with the phone number\n  const servicePlanId = process.env.SINCH_SERVICE_PLAN_ID ?? 'MY_SERVICE_PLAN_ID';\n\n  const sinch = new SinchClient({ projectId, keyId, keySecret });\n\n  try{\n    const response = await sinch.numbers.rent({\n      phoneNumber: phoneNumber,\n      rentNumberRequestBody: {\n        smsConfiguration: {\n          servicePlanId,\n        },\n      },\n    });\n    console.log('✅ Successfully rented the phone number.');\n    console.log(JSON.stringify(response, null, 2));\n  } catch (err) {\n    console.error(`❌ Failed to rent the phone number ${phoneNumber}:`);\n    console.error(err);\n  }\n}\n\nmain();\n"
      - lang: Python
        source: "\"\"\"\nSinch Python Snippet\n\nThis snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets\n\"\"\"\n\nimport os\nfrom dotenv import load_dotenv\nfrom sinch import SinchClient\nfrom sinch.domains.numbers.models.v1.types import SmsConfigurationDict\n\nload_dotenv()\n\nsinch_client = SinchClient(\n    project_id=os.environ.get(\"SINCH_PROJECT_ID\") or \"MY_PROJECT_ID\",\n    key_id=os.environ.get(\"SINCH_KEY_ID\") or \"MY_KEY_ID\",\n    key_secret=os.environ.get(\"SINCH_KEY_SECRET\") or \"MY_KEY_SECRET\"\n)\n\n# The available phone number to rent in E.164 format\nphone_number = \"PHONE_NUMBER\"\n# The service plan ID to associate with the phone number\nservice_plan_id = os.environ.get(\"SINCH_SERVICE_PLAN_ID\") or \"MY_SERVICE_PLAN_ID\"\nsms_configuration: SmsConfigurationDict = {\n    \"service_plan_id\": service_plan_id,\n}\n\nrented_number = sinch_client.numbers.rent(\n    phone_number=phone_number,\n    sms_configuration=sms_configuration\n)\nprint(\"Rented Number:\\n\", rented_number)\n"
  /v1/projects/{projectId}/availableNumbers:rentAny:
    parameters:
    - $ref: '#/components/parameters/projectId'
    post:
      tags:
      - Available Number
      summary: Rent any number that matches the criteria
      description: '**Deprecated:** This endpoint is deprecated. It remains available for existing integrations, but new integrations should use the Number Order API, which supports numbers from all regions and of all number types. To order numbers that match a set of criteria with a number order, use `quantityOrderOption` in the "Create a number order" endpoint.


        Activates the first available phone number that matches the search criteria provided in the request. You can''t review the specific number before it''s activated.


        **Note:** This endpoint only supports US `LOCAL` numbers, so `regionCode` must be `US` and `type` must be `LOCAL`.'
      operationId: NumberService_RentAnyNumber
      requestBody:
        description: The request to search and rent a number that matches the criteria.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RentAnyNumberRequest'
            examples:
              activateSMSNumber:
                $ref: '#/components/examples/SearchActivateSMSNumber'
        required: true
      responses:
        '200':
          description: A successful response, or an [error](https://developers.sinch.com/docs/numbers/api-reference/error-codes/status-codes).
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActiveNumberResponse'
        '400':
          description: 400 Invalid Argument error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidArgument'
        '403':
          $ref: '#/components/responses/PermissionDenied'
        '404':
          description: 404 Not Found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '500':
          description: 500 Internal Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
      deprecated: true
      x-codeSamples:
      - lang: Java
        source: "/**\n * Sinch Java Snippet\n *\n * <p>This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n * <p>See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage numbers;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.numbers.api.v1.NumbersService;\nimport com.sinch.sdk.domains.numbers.models.v1.ActiveNumber;\nimport com.sinch.sdk.domains.numbers.models.v1.NumberType;\nimport com.sinch.sdk.domains.numbers.models.v1.SmsConfiguration;\nimport com.sinch.sdk.domains.numbers.models.v1.request.AvailableNumberRentAnyRequest;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class RentAny {\n\n  private static final Logger LOGGER = Logger.getLogger(RentAny.class.getName());\n\n  public static void main(String[] args) {\n\n    String projectId = Settings.getProjectId().orElse(\"MY_PROJECT_ID\");\n    String keyId = Settings.getKeyId().orElse(\"MY_KEY_ID\");\n    String keySecret = Settings.getKeySecret().orElse(\"MY_KEY_SECRET\");\n\n    String servicePlanIdToAssociateWithTheNumber =\n        Settings.getServicePlanId().orElse(\"MY_SERVICE_PLAN_ID\");\n\n    // ISO 3166-1 alpha-2 country code of the phone number. e.g. \"US\", \"GB\", \"SE\"...\n    // See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 for details\n    String regionCode = \"MY_REGION_CODE\";\n\n    NumberType numberType = NumberType.LOCAL;\n\n    Configuration configuration =\n        Configuration.builder()\n            .setProjectId(projectId)\n            .setKeyId(keyId)\n            .setKeySecret(keySecret)\n            .build();\n\n    SinchClient client = new SinchClient(configuration);\n\n    NumbersService numbersService = client.numbers().v1();\n\n    SmsConfiguration smsConfiguration =\n        SmsConfiguration.builder().setServicePlanId(servicePlanIdToAssociateWithTheNumber).build();\n\n    AvailableNumberRentAnyRequest parameters =\n        AvailableNumberRentAnyRequest.builder()\n            .setType(numberType)\n            .setRegionCode(regionCode)\n            .setSmsConfiguration(smsConfiguration)\n            .build();\n\n    ActiveNumber response = numbersService.rentAny(parameters);\n\n    LOGGER.info(String.format(\"Rented number: %s\", response));\n  }\n}\n"
      - lang: Node.js
        source: "/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';\n  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';\n  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';\n\n  // The service plan ID to associate with the phone number\n  const servicePlanId = process.env.SINCH_SERVICE_PLAN_ID ?? 'MY_SERVICE_PLAN_ID';\n\n  const sinch = new SinchClient({ projectId, keyId, keySecret });\n\n  try{\n    const response = await sinch.numbers.rentAny({\n      rentAnyNumberRequestBody: {\n        regionCode: 'US',\n        type: 'LOCAL',\n        smsConfiguration: {\n          servicePlanId,\n        },\n      },\n    });\n    console.log('✅ Successfully rented a phone number.');\n    console.log(JSON.stringify(response, null, 2));\n  } catch (err) {\n    console.error('❌ Failed to rent a phone number:');\n    console.error(err);\n  }\n}\n\nmain();\n"
      - lang: Python
        source: "\"\"\"\nSinch Python Snippet\n\nThis snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets\n\"\"\"\n\nimport os\nfrom dotenv import load_dotenv\nfrom sinch import SinchClient\nfrom sinch.domains.numbers.models.v1.types import SmsConfigurationDict\n\nload_dotenv()\n\nsinch_client = SinchClient(\n    project_id=os.environ.get(\"SINCH_PROJECT_ID\") or \"MY_PROJECT_ID\",\n    key_id=os.environ.get(\"SINCH_KEY_ID\") or \"MY_KEY_ID\",\n    key_secret=os.environ.get(\"SINCH_KEY_SECRET\") or \"MY_KEY_SECRET\"\n)\n\n# The service plan ID to associate with the phone number\nservice_plan_id = os.environ.get(\"SINCH_SERVICE_PLAN_ID\") or \"MY_SERVICE_PLAN_ID\"\nsms_configuration: SmsConfigurationDict = {\n    \"service_plan_id\": service_plan_id,\n}\n# The URL to receive the notifications about provisioning events\nevent_destination_target = \"CALLBACK_URL\"\n\nresponse = sinch_client.numbers.rent_any(\n    region_code=\"US\",\n    number_type=\"LOCAL\",\n    capabilities=[\"SMS\", \"VOICE\"],\n    sms_configuration=sms_configuration,\n    event_destination_target=event_destination_target\n)\n\nprint(\"Rented Number:\\n\", response)\n"
  /v1/projects/{projectId}/availableNumbers:
    parameters:
    - $ref: '#/components/parameters/projectId'
    - $ref: '#/components/parameters/numberPattern.pattern'
    - $ref: '#/components/parameters/numberPattern.searchPattern'
    - $ref: '#/components/parameters/regionCodeRequired'
    - $ref: '#/components/parameters/typeRequired'
    - $ref: '#/components/parameters/capabilities'
    - name: size
      description: Optional. The maximum number of items to return.
      in: query
      required: false
      schema:
        type: integer
        format: int32
      example: 3
    get:
      summary: Search for available phone numbers
      description: 'Search for available phone numbers that are available for you to activate. You can filter by any property on the available number resource.


        When searching, indicate the `capability` of the number in the array as `SMS` and/or `VOICE`. To search for a number capable of both, list both `SMS` and `VOICE`.


        You can search for numbers in any region and of any number type. To buy a number from the search results, use the Number Order API.'
      operationId: NumberService_ListAvailableNumbers
      responses:
        '200':
          $ref: '#/components/responses/ListAvailableNumbersResponse'
        '400':
          description: 400 Invalid Argument error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidArgument'
        '403':
          $ref: '#/components/responses/PermissionDenied'
        '404':
          description: 404 Not Found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '500':
          description: 500 Internal Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
      tags:
      - Available Number
      x-codeSamples:
      - lang: Java
        source: "/**\n * Sinch Java Snippet\n *\n * <p>This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n * <p>See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage numbers;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.numbers.api.v1.NumbersService;\nimport com.sinch.sdk.domains.numbers.models.v1.NumberType;\nimport com.sinch.sdk.domains.numbers.models.v1.request.AvailableNumbersListQueryParameters;\nimport com.sinch.sdk.domains.numbers.models.v1.response.AvailableNumbersListResponse;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class SearchForAvailableNumbers {\n\n  private static final Logger LOGGER = Logger.getLogger(SearchForAvailableNumbers.class.getName());\n\n  public static void main(String[] args) {\n\n    String projectId = Settings.getProjectId().orElse(\"MY_PROJECT_ID\");\n    String keyId = Settings.getKeyId().orElse(\"MY_KEY_ID\");\n    String keySecret = Settings.getKeySecret().orElse(\"MY_KEY_SECRET\");\n\n    // ISO 3166-1 alpha-2 country code of the phone number. e.g. \"US\", \"GB\", \"SE\"...\n    // See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 for details\n    String regionCode = \"MY_REGION_CODE\";\n    NumberType type = NumberType.LOCAL;\n\n    Configuration configuration =\n        Configuration.builder()\n            .setProjectId(projectId)\n            .setKeyId(keyId)\n            .setKeySecret(keySecret)\n            .build();\n\n    SinchClient client = new SinchClient(configuration);\n\n    NumbersService numbersService = client.numbers().v1();\n\n    AvailableNumbersListQueryParameters parameters =\n        AvailableNumbersListQueryParameters.builder()\n            .setRegionCode(regionCode)\n            .setType(type)\n            .build();\n\n    LOGGER.info(\"Looking for available numbers\");\n\n    AvailableNumbersListResponse response = numbersService.searchForAvailableNumbers(parameters);\n\n    response\n        .iterator()\n        .forEachRemaining(\n            number -> LOGGER.info(String.format(\"Available number details: %s\", number)));\n  }\n}\n"
      - lang: Node.js
        source: "/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';\n  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';\n  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';\n\n  const sinch = new SinchClient({ projectId, keyId, keySecret });\n\n  try{\n    const response = await sinch.numbers.searchForAvailableNumbers({\n      regionCode: 'US',\n      type: 'LOCAL',\n    });\n    if (!response.availableNumbers?.length) {\n      console.log('No phone numbers are available with these criteria.');\n      return;\n    }\n    console.log(`✅ Found ${response.availableNumbers.length} numbers to rent.`);\n    response.availableNumbers.forEach((number) => {\n      console.log(number);\n    });\n  } catch (err) {\n    console.error('❌ Failed to list phone numbers to rent:');\n    console.error(err);\n  }\n}\n\nmain();\n"
      - lang: Python
        source: "\"\"\"\nSinch Python Snippet\n\nThis snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets\n\"\"\"\n\nimport os\nfrom dotenv import load_dotenv\nfrom sinch import SinchClient\n\nload_dotenv()\n\nsinch_client = SinchClient(\n    project_id=os.environ.get(\"SINCH_PROJECT_ID\") or \"MY_PROJECT_ID\",\n    key_id=os.environ.get(\"SINCH_KEY_ID\") or \"MY_KEY_ID\",\n    key_secret=os.environ.get(\"SINCH_KEY_SECRET\") or \"MY_KEY_SECRET\"\n)\n\navailable_numbers = sinch_client.numbers.search_for_available_numbers(\n    region_code=\"AR\",\n    number_type=\"LOCAL\"\n)\n\nprint(\"Available numbers to rent:\\n\")\nfor number in available_numbers.iterator():\n    print(number)\n"
  /v1/projects/{projectId}/availableNumbers/{phoneNumber}:
    parameters:
    - $ref: '#/components/parameters/projectId'
    - $ref: '#/components/parameters/phoneNumber'
    get:
      summary: Search for a specific phone number
      description: 'This endpoint allows you to enter a specific phone number to check if it''s available for use. A 200 response will return the number''s capability, setup costs, monthly costs and if supporting documentation is required.


        To buy the number, use the Number Order API.'
      operationId: NumberService_GetAvailableNumber
      responses:
        '200':
          $ref: '#/components/responses/AvailableNumberResponse'
        '400':
          description: 400 Invalid Argument error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidArgument'
        '403':
          $ref: '#/components/responses/PermissionDenied'
        '404':
          description: 404 Not Found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '500':
          description: 500 Internal Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
      tags:
      - Available Number
      x-codeSamples:
      - lang: Java
        source: "/**\n * Sinch Java Snippet\n *\n * <p>This snippet is available at https://github.com/sinch/sinch-sdk-java\n *\n * <p>See https://github.com/sinch/sinch-sdk-java/blob/main/examples/snippets/README.md for details\n */\npackage numbers;\n\nimport com.sinch.sdk.SinchClient;\nimport com.sinch.sdk.domains.numbers.api.v1.NumbersService;\nimport com.sinch.sdk.domains.numbers.models.v1.response.AvailableNumber;\nimport com.sinch.sdk.models.Configuration;\nimport java.util.logging.Logger;\nimport utils.Settings;\n\npublic class CheckAvailability {\n\n  private static final Logger LOGGER = Logger.getLogger(CheckAvailability.class.getName());\n\n  public static void main(String[] args) {\n\n    String projectId = Settings.getProjectId().orElse(\"MY_PROJECT_ID\");\n    String keyId = Settings.getKeyId().orElse(\"MY_KEY_ID\");\n    String keySecret = Settings.getKeySecret().orElse(\"MY_KEY_SECRET\");\n\n    String phoneNumber = \"A_PHONE_NUMBER_TO_CHECK\";\n\n    Configuration configuration =\n        Configuration.builder()\n            .setProjectId(projectId)\n            .setKeyId(keyId)\n            .setKeySecret(keySecret)\n            .build();\n\n    SinchClient client = new SinchClient(configuration);\n\n    NumbersService numbersService = client.numbers().v1();\n\n    LOGGER.info(\"CheckAvailability for: \" + phoneNumber);\n\n    AvailableNumber value = numbersService.checkAvailability(phoneNumber);\n\n    LOGGER.info(\"Response: \" + value);\n  }\n}\n"
      - lang: Node.js
        source: "/**\n * Sinch Node.js Snippet\n * See: https://github.com/sinch/sinch-sdk-node/examples/snippets\n */\nimport { SinchClient } from '@sinch/sdk-core';\nimport * as dotenv from 'dotenv';\ndotenv.config();\n\nasync function main() {\n  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';\n  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';\n  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';\n\n  // The phone number to check for rental availability\n  const phoneNumber = 'PHONE_NUMBER';\n\n  const sinch = new SinchClient({ projectId, keyId, keySecret });\n\n  try{\n    const response = await sinch.numbers.checkAvailability({ phoneNumber });\n    console.log('✅ Phone number is available to rent.');\n    console.log(JSON.stringify(response, null, 2));\n  } catch (err) {\n    console.error(`❌ Failed to get a successful status for the phone number's availability (${phoneNumber}):`);\n    console.error(err);\n  }\n}\n\nmain();\n"
      - lang: Python
        source: "\"\"\"\nSinch Python Snippet\n\nThis snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets\n\"\"\"\n\nimport os\nfrom dotenv import load_dotenv\nfrom sinch import SinchClient\n\nload_dotenv()\n\nsinch_client = SinchClient(\n    project_id=os.environ.get(\"SINCH_PROJECT_ID\") or \"MY_PROJECT_ID\",\n    key_id=os.environ.get(\"SINCH_KEY_ID\") or \"MY_KEY_ID\",\n    key_secret=os.environ.get(\"SINCH_KEY_SECRET\") or \"MY_KEY_SECRET\"\n)\n\n# The phone number to check in E.164 format\nphone_number = \"PHONE_NUMBER\"\n\nresponse = sinch_client.numbers.check_availability(\n    phone_number=phone_number\n)\n\nprint(\"The phone number is available:\\n\", response)\n"
components:
  schemas:
    FieldViolation:
      type: object
      properties:
        field:
          type: string
        description:
          type: string
    NumberType:
      type: string
      enum:
      - MOBILE
      - LOCAL
      - TOLL_FREE
      x-enumDescriptions:
        MOBILE: Numbers that belong to a specific range.
        LOCAL: Numbers that are assigned to a specific geographic region.
        TOLL_FREE: Numbers that are free of charge for the calling party but billed for all arriving calls.
      description: The number type.
      title: Type
    BadRequest:
      type: object
      properties:
        type:
          type: string
          enum:
          - BadRequest
          x-enumDescriptions:
            BadRequest: The request was malformed in some way.
        fieldViolations:
          type: array
          items:
            $ref: '#/components/schemas/FieldViolation'
    RegionCode:
      type: string
      example: US
      description: 'ISO 3166-1 alpha-2 country code of the phone number. Example: US, GB or SE.'
      title: Region Code
    NumberPattern:
      type: object
      properties:
        pattern:
          type: string
          description: Sequence of digits to search for.
        searchPattern:
          $ref: '#/components/schemas/NumberPatternSearchPattern'
      title: Search Pattern
    ScheduledVoiceProvisioning:
      type: object
      readOnly: true
      description: Represents the ongoing or failed scheduled voice provisioning job. This field will be empty if the number was successfully provisioned provisioned for voice.
      required:
      - type
      oneOf:
      - $ref: '#/components/schemas/ScheduledVoiceProvisioningEST'
      - $ref: '#/components/schemas/ScheduledVoiceProvisioningFAX'
      - $ref: '#/components/schemas/ScheduledVoiceProvisioningRTC'
      discriminator:
        propertyName: type
        mapping:
          EST: '#/components/schemas/ScheduledVoiceProvisioningEST'
          FAX: '#/components/schemas/ScheduledVoiceProvisioningFAX'
          RTC: '#/components/schemas/ScheduledVoiceProvisioningRTC'
      title: Scheduled Voice Provisioning
    RentNumberRequest:
      type: object
      properties:
        smsConfiguration:
          $ref: '#/components/schemas/smsConfiguration'
        voiceConfiguration:
          $ref: '#/components/schemas/VoiceConfiguration'
        callbackUrl:
          type: string
          description: The callback URL to be called for a rented number's provisioning / deprovisioning operations.
      description: Request message for renting a phone number.
      title: Rent Number Request
    money:
      type: object
      description: An object giving details on currency code and the amount charged.
      properties:
        currencyCode:
          type: string
          example: USD
          description: The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html).
        amount:
          type: string
          example: '2.00'
          description: 'The amount in decimal form.

            For example `2.00`.

            There are no guarantees on the precision unless documented by the message origin. The amount cannot be updated and is read-only.'
      title: Money
    NumberPatternSearchPattern:
      type: string
      enum:
      - START
      - CONTAINS
      - END
      x-enumDescriptions:
        START: Numbers that start with the provided sequence of digits.
        CONTAINS: Numbers that contain the sequence of digits entered.
        END: Numbers that end with the sequence of digits entered.
      description: The pattern to apply to searches.
      title: Search Pattern
    NumberCapability:
      type: string
      enum:
      - SMS
      - VOICE
      x-enumDescriptions:
        SMS: The SMS product can use the number.
        VOICE: The Voice product can use the number.
      default: SMS
      description: 'The capabilities the phone number supports: SMS, Voice, or both'
      title: Capability
    ScheduledVoiceProvisioningEST:
      type: object
      allOf:
      - $ref: '#/components/schemas/ScheduledVoiceProvisioningCommon'
      - $ref: '#/components/schemas/VoiceTrunkId'
    ProvisioningStatus:
      default: WAITING
      description: The provisioning status. It will be either `WAITING`, `IN_PROGRESS` or `FAILED`. If the provisioning fails, a reason for the failure will be provided. [See a full list of provisioning error descriptions]<(https://developers.sinch.com/docs/numbers/api-reference/error-codes/provisioning-errors) and troubleshooting recommendations.
      enum:
      - PROVISIONING_STATUS_UNSPECIFIED
      - WAITING
      - IN_PROGRESS
      - FAILED
      x-enumDescriptions:
        PROVISIONING_STATUS_UNSPECIFIED: The status is currently unknown.
        WAITING: Waiting for provisioning
        IN_PROGRESS: Provisioning in progress
        FAILED: Provisioning failed. See [provisioning error descriptions](https://developers.sinch.com/docs/numbers/api-reference/error-codes/provisioning-errors)
      title: Provisioning Status
    VoiceConfigurationCommon:
      title: Common VoiceConfiguration fields
      type: object
      properties:
        type:
          $ref: '#/components/schemas/VoiceApplicationType'
        lastUpdatedTime:
          type: string
          description: Timestamp when the status was last updated.
          format: date-time
          readOnly: true
        scheduledVoiceProvisioning:
          readOnly: true
          allOf:
          - $ref: '#/components/schemas/ScheduledVoiceProvisioning'
    VoiceAppId:
      type: object
      properties:
        appId:
          type: string
          description: Your app ID for the Voice API. The `appId` can be found in your [Sinch Customer Dashboard](https://dashboard.sinch.com/voice/apps).
    VoiceConfigurationEST:
      title: EST VoiceConfiguration
      type: object
      required:
      - type
      allOf:
      - $ref: '#/components/schemas/VoiceConfigurationCommon'
      - $ref: '#/components/schemas/VoiceTrunkId'
    ScheduledVoiceProvisioningFAX:
      type: object
      allOf:
      - $ref: '#/components/schemas/ScheduledVoiceProvisioningCommon'
      - $ref: '#/components/schemas/VoiceServiceId'
    NotFound:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
              enum:
              - 404
              x-enumDescriptions:
                '404': The HTTP status code for a resource not found.
            message:
              type: string
            status:
              type: string
              enum:
              - NOT_FOUND
              x-enumDescriptions:
                NOT_FOUND: The request resource could not be found.
            details:
              type: array
              items:
                $ref: '#/components/schemas/NotFoundErrorDetails'
    AvailableNumber:
      type: object
      properties:
        phoneNumber:
          $ref: '#/components/schemas/PhoneNumber'
        regionCode:
          $ref: '#/components/schemas/RegionCode'
        type:
          $ref: '#/components/schemas/NumberType'
        capability:
          type: array
          description: The capability of the number.
          example:
          - SMS
          - VOICE
          items:
            $ref: '#/components/schemas/NumberCapability'
        setupPrice:
          $ref: '#/components/schemas/money'
        monthlyPrice:
          $ref: '#/components/schemas/money'
        paymentIntervalMonths:
          type: integer
          format: int32
          description: How often the recurring price is charged in months.
          readOnly: true
        supportingDocumentationRequired:
          type: boolean
          description: 'Whether regulations in the number''s region require supplementary documentation (for example, business or identity documents) to buy numbers of this type. The value is determined by the regulatory requirements for the number''s region and number type, so it''s the same for every number of that type in that region.


            If `true`, use the [Number Order](https://developers.sinch.com/docs/numbers/api-reference/numbers/number-order) API to buy the number: call "Lookup number requirements" to find out exactly which information and documents are required, then provide them with the order''s registration and attachment endpoints before submitting the order.'
          readOnly: true
      description: The phone numbers that are available to be rented in [dashboard.sinch.com](https://dashboard.sinch.com/numbers/buy-numbers) or via the public numbers API.
      title: Available Number
    VoiceTrunkId:
      type: object
      properties:
        trunkId:
          type: string
          description: The trunk ID if the type is EST. The `trunkId` can be found in your [Sinch Customer Dashboard](https://dashboard.sinch.com/trunks/your-trunks).
    VoiceConfiguration:
      title: VoiceConfiguration
      type: object
      oneOf:
      - $ref: '#/components/schemas/VoiceConfigurationRTC'
      - $ref: '#/components/schemas/VoiceConfigurationEST'
      - $ref: '#/components/schemas/VoiceConfigurationFAX'
      discriminator:
        propertyName: type
        mapping:
          RTC: '#/components/schemas/VoiceConfigurationRTC'
          EST: '#/components/schemas/VoiceConfigurationEST'
          FAX: '#/components/schemas/VoiceConfigurationFAX'
      description: The current voice configuration for this number. During scheduled provisioning, the app ID, service ID, or trunk ID value may be empty in a response if it is still processing or if it has failed. The status of scheduled provisioning will show under a `scheduledVoiceProvisioning` object if it's still running. Once processed successfully, the `appId`/`serviceId`/`trunkId` sent will appear directly under the `voiceConfiguration` object.
    VoiceApplicationType:
      type: string
      description: The voice application type. Examples are RTC, EST, FAX
      x-enumDescriptions:
        RTC: Voice [see documentation](https://developers.sinch.com/docs/voice)
        EST: Elastic SIP Trunking [see documentation](https://developers.sinch.com/docs/est)
        FAX: FAX application [see documentation](https://developers.sinch.com/docs/fax/overview)
      enum:
      - RTC
      - EST
      - FAX
      default: RTC
    InternalError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
              enum:
              - 500
              x-enumDescriptions:
                '500': The HTTP status code for an internal server error.
            message:
              type: string
            status:
              type: string
              enum:
              - INTERNAL
              - UNKNOWN
              x-enumDescriptions:
                INTERNAL: An internal server error.
                UNKNOWN: Some unknown error.
            details:
              type: array
              items:
                type: object
    VoiceServiceId:
      type: object
      properties:
        serviceId:
          type: string
          description: The service ID if the type is FAX. The `serviceId` can be found in your [Sinch Customer Dashboard](https://dashboard.sinch.com/fax/services).
    RentAnyNumberRequest:
      title: RentAnyNumberRequest
      required:
      - regionCode
      - type
      type: object
      properties:
        numberPattern:
          $ref: '#/components/schemas/NumberPattern'
        regionCode:
          allOf:
          - $ref: '#/components/schemas/RegionCode'
          description: ISO 3166-1 alpha-2 country code of the phone number. This endpoint only supports `US`.
        type:
          allOf:
          - $ref: '#/components/schemas/NumberType'
          description: Number type. This endpoint only supports `LOCAL`.
        capabilities:
          type: array
          items:
            $ref: '#/components/schemas/NumberCapability'
          description: Number capabilities to filter by, `SMS` and/or `VOICE`.
        smsConfiguration:
          $ref: '#/components/schemas/smsConfiguration'
        voiceConfiguration:
          $ref: '#/components/schemas/VoiceConfiguration'
        callbackUrl:
          type: string
          description: The callback URL to be called for a rented number's provisioning / deprovisioning operations.
          example: https://www.your-callback-server.com/callback
      description: Request message for searching and renting in one go any number that matches the search criteria.
    ActiveNumberResponse:
      type: object
      properties:
        phoneNumber:
          $ref: '#/components/schemas/PhoneNumber'
        projectId:
          type: string
          example: 51bc3f40-f266-4ca8-8938-a1ed0ff32b9a
          description: Project ID. Your project ID can be found on your [Sinch Customer Dashboard](https://dashboard.sinch.com/settings/project-management).
        displayName:
          type: string
          description: User supplied name for the phone number.
        regionCode:
          $ref: '#/components/schemas/RegionCode'
        type:
          $ref: '#/components/schemas/NumberType'
        capability:
          description: The capability of the number.
          type: array
          example:
          - SMS
          items:
            $ref: '#/components/schemas/NumberCapability'
        money:
          $ref: '#/components/schemas/money'
        paymentIntervalMonths:
          type: integer
          format: int32
          description: How often the recurring price is charged in months.
          readOnly: true
        nextChargeDate:
          type: string
          format: date-time
          description: The date of the next charge.
          readOnly: true
        expireAt:
          type: string
          format: date-time
          description: The timestamp when the subscription will expire if an expiration date has been set.
          readOnly: true
        smsConfiguration:
          $ref: '#/components/schemas/smsConfiguration'
        voiceConfiguration:
          $ref: '#/components/schemas/VoiceConfiguration'
        callbackUrl:
          type: string
          description: The callback URL to be called for a rented number's provisioning / deprovisioning operations.
          example: https://www.your-callback-server.com/callback
      description: The phone number that has been bought by a customer and assigned to a project.
      title: Active Number Response
    ListAvailableNumbersResponse:
      type: object
      properties:
        availableNumbers:
          type: array
          items:
            $ref: '#/components/schemas/AvailableNumber'
          description: List of available phone numbers.
      description: Response message to list available phone numbers.
      title: Available Numbers Response
    NotFoundErrorDetails:
      type: object
      properties:
        type:
          type: string
        resourceType:
          type: string
          description: The type of the resource that was not found.
        resourceName:
          type: string
          description: The name of the resource that was not found.
        owner:
          type: string
          description: The owner of the resource that was not found.
        description:
          type: string
          description: A description of the error.
    smsConfigurationBase:
      title: Base SMS Configuration
      type: object
      required:
      - servicePlanId
      properties:
        servicePlanId:
          type: string
          description: The `servicePlanId` can be found in the [Sinch Customer Dashboard](https://dashboard.sinch.com/sms/api/rest). The service plan ID is what ties this number to the configured SMS service.
        campaignId:
          type: string
          description: Only for US phone numbers. This `campaignId` is required to send SMS traffic to US; click [here](https://community.sinch.com/t5/10DLC/What-is-10DLC/ta-p/7845) to read more about 10DLC A2P messaging. So, it is the current campaign ID for this number. The `campaignId` is found on your TCR platform.
    smsConfiguration:
      type: object
      title: SMS Configuration
      description: 'The current SMS configuration for this number.


        Once the `servicePlanId` is sent, it enters scheduled provisioning.


        The status of scheduled provisioning will show under a `scheduledProvisioning` object if it''s still running. Once processed successfully, the `servicePlanId` sent will appear directly under the `smsConfiguration` object.'
      allOf:
      - $ref: '#/components/schemas/smsConfigurationBase'
      - type: object
        properties:
          scheduledProvisioning:
            readOnly: true
            allOf:
            - $ref: '#/components/schemas/scheduledProvisioning'
    VoiceConfigurationRTC:
      title: RTC VoiceConfiguration
      type: object
      allOf:
      - $ref: '#/components/schemas/VoiceConfigurationCommon'
      - $ref: '#/components/schemas/VoiceAppId'
    InvalidArgument:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
              enum:
              - 400
              x-enumDescriptions:
                '400': The HTTP status code for invalid arguments.
            message:
              type: string
            status:
              type: string
              enum:
              - INVALID_ARGUMENT
              x-enumDescriptions:
                INVALID_ARGUMENT: The request contained invalid arguments.
            details:
              type: array
              items:
                $ref: '#/components/schemas/BadRequest'
    ScheduledVoiceProvisioningCommon:
      type: object
      required:
      - type
      allOf:
      - type: object
        properties:
          type:
            $ref: '#/components/schemas/VoiceApplicationType'
          lastUpdatedTime:
            type: string
            description: Timestamp when the status was last updated.
            format: date-time
            readOnly: true
          status:
            $ref: '#/components/schemas/ProvisioningStatus'
    PhoneNumber:
      type: string
      example: '+12025550134'
      description: The phone number in [E.164](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537) format with leading `+`. Example `+12025550134`.
      title: Phone Number
    SmsErrorCode:
      type: string
      x-enumDescriptions:
        ERROR_CODE_UNSPECIFIED: Code not specified.
        INTERNAL_ERROR: Internal server error.
        SMS_PROVISIONING_FAILED: Provisioning for SMS failed.
        CAMPAIGN_PROVISIONING_FAILED: Provisioning for campaign failed.
        CAMPAIGN_NOT_AVAILABLE: The specified campaign is not available.
        EXCEEDED_10DLC_LIMIT: Exceeded the 10DLC limit.
        NUMBER_PROVISIONING_FAILED: Failed to provision the number.
        PARTNER_SERVICE_UNAVAILABLE: The third party service is unavailable.
        CAMPAIGN_PENDING_ACCEPTANCE: The campaign is awaiting acceptance.
        MNO_SHARING_ERROR: Sharing error.
        CAMPAIGN_EXPIRED: The specific campaign has expired.
        CAMPAIGN_MNO_REJECTED: The MNO for the campaign was rejected.
        CAMPAIGN_MNO_SUSPENDED: The MNO for the campaign was suspended.
        CAMPAIGN_MNO_REVIEW: The MNO for the campaign is under review.
        INSUFFICIENT_BALANCE: The credit balance for the account is insufficient to cover the fees.
        MOCK_CAMPAIGN_NOT_ALLOWED: Mock campaign is not permitted.
        TFN_NOT_ALLOWED: The Toll-Free number is not allowed.
        INVALID_NNID: The specified NNID is invalid.
      enum:
      - ERROR_CODE_UNSPECIFIED
      - INTERNAL_ERROR
      - SMS_PROVISIONING_FAILED
      - CAMPAIGN_PROVISIONING_FAILED
      - CAMPAIGN_NOT_AVAILABLE
      - EXCEEDED_10DLC_LIMIT
      - NUMBER_PROVISIONING_FAILED
      - PARTNER_SERVICE_UNAVAILABLE
      - CAMPAIGN_PENDING_ACCEPTANCE
      - MNO_SHARING_ERROR
      - CAMPAIGN_EXPIRED
      - CAMPAIGN_MNO_REJECTED
      - CAMPAIGN_MNO_SUSPENDED
      - CAMPAIGN_MNO_REVIEW
      - INSUFFICIENT_BALANCE
      - MOCK_CAMPAIGN_NOT_ALLOWED
      - TFN_NOT_ALLOWED
      - INVALID_NNID
      description: The error codes that show the reason of failure of a scheduled provisioning
      title: SMS Error Code
    scheduledProvisioning:
      type: object
      description: Represents the ongoing or failed scheduled provisioning job. This field will be empty if the number was both successfully provisioned to the SMS platform and linked to the 10DLC campaign.
      properties:
        servicePlanId:
          type: string
          description: The SMS service plan that the scheduled provisioning job will configure with the number.
          readOnly: true
        campaignId:
          type: string
          description: TCR campaign ID that the scheduled provisioning job will configure with the number.
          readOnly: true
        status:
          $ref: '#/components/schemas/ProvisioningStatus'
        lastUpdatedTime:
          type: string
          format: date-time
          description: Timestamp when the status was last updated.
          readOnly: true
        errorCodes:
          type: array
          items:
            $ref: '#/components/schemas/SmsErrorCode'
          readOnly: true
      title: Scheduled Provisioning
    VoiceConfigurationFAX:
      title: FAX VoiceConfiguration
      type: object
      required:
      - type
      allOf:
      - $ref: '#/components/schemas/VoiceConfigurationCommon'
      - $ref: '#/components/schemas/VoiceServiceId'
    ScheduledVoiceProvisioningRTC:
      type: object
      allOf:
      - $ref: '#/components/schemas/ScheduledVoiceProvisioningCommon'
      - $ref: '#/components/schemas/VoiceAppId'
  responses:
    ActiveNumberResponse:
      description: A successful response, or an [Error](https://developers.sinch.com/docs/numbers/api-reference/error-codes/status-codes/).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ActiveNumberResponse'
          examples:
            activateBothSMSandVoiceNumber:
              $ref: '#/components/examples/activateBothSMSandVoiceNumberRes'
            activateSMSNumber:
              $ref: '#/components/examples/activateSMSNumberRes'
            activateVoiceNumber:
              $ref: '#/components/examples/activateVoiceNumberRes'
            activateESTNumber:
              $ref: '#/components/examples/activateESTNumberRes'
            activateFaxNumber:
              $ref: '#/components/examples/activateFaxNumberRes'
    PermissionDenied:
      description: 'PERMISSION_DENIED: improper credentials. Be sure your projectId, username and password are correct.'
      content:
        application/json:
          schema: {}
          example:
            error:
              code: 403
              message: ''
              status: PERMISSION_DENIED
              details: []
    AvailableNumberResponse:
      description: A successful response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AvailableNumber'
    ListAvailableNumbersResponse:
      description: A successful response, or an [Error](https://developers.sinch.com/docs/numbers/api-reference/error-codes/status-codes/).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ListAvailableNumbersResponse'
  requestBodies:
    RentNumberRequest:
      description: The request to rent a number.
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RentNumberRequest'
          examples:
            activateBothSMSandVoiceNumber:
              $ref: '#/components/examples/activateBothSMSandVoiceNumberReq'
            activateSMSNumber:
              $ref: '#/components/examples/activateSMSNumberReq'
            activateVoiceNumber:
              $ref: '#/components/examples/activateVoiceNumberReq'
            activateESTNumber:
              $ref: '#/components/examples/activateESTNumberReq'
            activateFaxNumber:
              $ref: '#/components/examples/activateFaxNumberReq'
  examples:
    activateVoiceNumberReq:
      summary: Activate number with Voice configuration
      value:
        voiceConfiguration:
          type: RTC
          appId: YOUR_app_id
        callbackUrl: https://www.your-callback-server.com/callback
    activateFaxNumberReq:
      summary: Activate number with Fax configuration
      value:
        voiceConfiguration:
          type: FAX
          serviceId: YOUR_service_id
        callbackUrl: https://www.your-callback-server.com/callback
    activateFaxNumberRes:
      summary: Response for activing a number with Fax configuration
      value:
        phoneNumber: '+12025550134'
        projectId: 51bc3f40-f266-4ca8-8938-a1ed0ff32b9a
        displayName: MyPhoneNumber
        regionCode: US
        type: LOCAL
        capability:
        - VOICE
        money:
          currencyCode: USD
          amount: '2.00'
        paymentIntervalMonths: 0
        nextChargeDate: '2024-08-24T14:15:22Z'
        expireAt: '2024-09-24T14:15:22Z'
        voiceConfiguration:
          type: FAX
          lastUpdatedTime: '2024-09-24T14:15:22Z'
          scheduledVoiceProvisioning:
            type: FAX
            lastUpdatedTime: '2024-09-24T14:15:22Z'
            status: WAITING
            serviceId: YOUR_service_id
          serviceId: YOUR_service_id
    activateSMSNumberReq:
      summary: Activate number with SMS configuration
      value:
        smsConfiguration:
          servicePlanId: YOUR_SMS_servicePlanId
          campaignId: YOUR_campaignId_from_TCR
        callbackUrl: https://www.your-callback-server.com/callback
    activateESTNumberReq:
      summary: Activate number with Elastic SIP Trunking configuration
      value:
        voiceConfiguration:
          type: EST
          trunkId: YOUR_trunk_id
        callbackUrl: https://www.your-callback-server.com/callback
    activateSMSNumberRes:
      summary: Response for activing a number with SMS configuration
      value:
        phoneNumber: '+12025550134'
        projectId: 51bc3f40-f266-4ca8-8938-a1ed0ff32b9a
        displayName: MyPhoneNumber
        regionCode: US
        type: MOBILE
        capability:
        - SMS
        money:
          currencyCode: USD
          amount: '2.00'
        paymentIntervalMonths: 0
        nextChargeDate: '2024-08-24T14:15:22Z'
        expireAt: '2024-09-24T14:15:22Z'
        smsConfiguration:
          servicePlanId: YOUR_service_plan_id
          scheduledProvisioning:
            servicePlanId: YOUR_service_plan_id
            status: WAITING
            lastUpdatedTime: '2024-08-04T14:15:22Z'
            campaignId: YOUR_campaign_id
          campaignId: YOUR_campaign_id
    SearchActivateSMSNumber:
      summary: Search and activate a number that matches criteria and sets the SMS configuration
      value:
        regionCode: US
        type: LOCAL
        capabilities:
        - SMS
        numberPattern:
          pattern: '+1208'
          searchPattern: START
        smsConfiguration:
          servicePlanId: YOUR_SMS_servicePlanId
          campaignId: YOUR_campaignId_from_TCR
        callbackUrl: https://www.your-callback-server.com/callback
    activateVoiceNumberRes:
      summary: Response for activing a number with Voice configuration
      value:
        phoneNumber: '+12025550134'
        projectId: 51bc3f40-f266-4ca8-8938-a1ed0ff32b9a
        displayName: MyPhoneNumber
        regionCode: US
        type: MOBILE
        capability:
        - VOICE
        money:
          currencyCode: USD
          amount: '2.00'
        paymentIntervalMonths: 0
        nextChargeDate: '2024-08-24T14:15:22Z'
        expireAt: '2024-09-24T14:15:22Z'
        voiceConfiguration:
          type: RTC
          lastUpdatedTime: '2024-09-24T14:15:22Z'
          scheduledVoiceProvisioning:
            type: RTC
            lastUpdatedTime: '2024-09-24T14:15:22Z'
            status: WAITING
            appId: YOUR_app_id
          appId: YOUR_app_id
    activateESTNumberRes:
      summary: Response for activing a number with Elastic SIP Trunking configuration
      value:
        phoneNumber: '+12025550134'
        projectId: 51bc3f40-f266-4ca8-8938-a1ed0ff32b9a
        displayName: MyPhoneNumber
        regionCode: US
        type: LOCAL
        capability:
        - VOICE
        money:
          currencyCode: USD
          amount: '2.00'
        paymentIntervalMonths: 0
        nextChargeDate: '2024-08-24T14:15:22Z'
        expireAt: '2024-09-24T14:15:22Z'
        voiceConfiguration:
          type: EST
          lastUpdatedTime: '2024-09-24T14:15:22Z'
          scheduledVoiceProvisioning:
            type: EST
            lastUpdatedTime: '2024-09-24T14:15:22Z'
            status: WAITING
            trunkId: YOUR_trunk_id
          trunkId: YOUR_trunk_id
    activateBothSMSandVoiceNumberRes:
      summary: Response for activing a number with both SMS and Voice configuration
      value:
        phoneNumber: '+12025550134'
        projectId: 51bc3f40-f266-4ca8-8938-a1ed0ff32b9a
        displayName: MyPhoneNumber
        regionCode: US
        type: MOBILE
        capability:
        - SMS
        - VOICE
        money:
          currencyCode: USD
          amount: '2.00'
        paymentIntervalMonths: 0
        nextChargeDate: '2024-08-24T14:15:22Z'
        expireAt: '2024-09-24T14:15:22Z'
        smsConfiguration:
          servicePlanId: YOUR_service_plan_id
          scheduledProvisioning:
            servicePlanId: ''
            status: WAITING
            lastUpdatedTime: '2024-08-04T14:15:22Z'
            campaignId: YOUR_campaign_id
          campaignId: YOUR_campaign_id
        voiceConfiguration:
          type: RTC
          lastUpdatedTime: '2024-09-24T14:15:22Z'
          scheduledVoiceProvisioning:
            type: RTC
            lastUpdatedTime: '2024-09-24T14:15:22Z'
            status: WAITING
            appId: YOUR_app_id
          appId: YOUR_app_id
    activateBothSMSandVoiceNumberReq:
      summary: Activate number with SMS and Voice configuration
      value:
        smsConfiguration:
          servicePlanId: YOUR_SMS_servicePlanId
        voiceConfiguration:
          type: RTC
          appId: YOUR_Voice_appId
        callbackUrl: https://www.your-callback-server.com/callback
  parameters:
    numberPattern.searchPattern:
      name: numberPattern.searchPattern
      description: Search pattern to apply. The options are, `START`, `CONTAINS`, and `END`.
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/NumberPatternSearchPattern'
    regionCodeRequired:
      name: regionCode
      description: 'Region code to filter by. ISO 3166-1 alpha-2 country code of the phone number. Example: US, GB or SE.'
      in: query
      required: true
      schema:
        type: string
        example: US
    phoneNumber:
      name: phoneNumber
      description: Output only. The phone number in [E.164](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537) format with leading `+`.
      in: path
      required: true
      schema:
        type: string
        example: '+12025550134'
        default: YOUR_selected_phoneNumber_from_search
    typeRequired:
      name: type
      description: Number type to filter by. Options include, `MOBILE`, `LOCAL` or `TOLL_FREE`.
      in: query
      required: true
      schema:
        $ref: '#/components/schemas/NumberType'
    projectId:
      name: projectId
      description: Found on your [Sinch Customer Dashboard](https://dashboard.sinch.com/settings/project-management). Settings > Projects.
      in: path
      required: true
      schema:
        type: string
        example: YOUR_projectId
    capabilities:
      name: capabilities
      description: Number capabilities to filter by SMS and/or VOICE.
      in: query
      required: false
      schema:
        type: array
        items:
          $ref: '#/components/schemas/NumberCapability'
    numberPattern.pattern:
      name: numberPattern.pattern
      description: Sequence of digits to search for. If you prefer or need certain digits in sequential order, you can enter the sequence of numbers here. For example, `2020`.
      in: query
      required: false
      schema:
        type: string
        example: '%2B120'
  securitySchemes:
    Basic:
      type: http
      scheme: basic
      description: Your key ID and Key secret serve as the username and password, respectively. Both can be found in the [Sinch Customer Dashboard](https://dashboard.sinch.com/settings/access-keys). For more information about basic authentication in the Numbers API, click [here](https://developers.sinch.com/docs/numbers/api-reference/authentication/basic).
    OAuth2.0:
      type: oauth2
      description: The username and password are your Key ID and Key Secret from the [Access keys section](https://dashboard.sinch.com/settings/access-keys) in the Sinch Customer Dashboard. Exchange these for a bearer token (access token). Learn how [here](https://developers.sinch.com/docs/numbers/api-reference/authentication/oauth).
      flows:
        clientCredentials:
          tokenUrl: https://auth.sinch.com/oauth2/token
          scopes: {}
x-explorer-enabled: false
x-samples-languages:
- curl
- java
- csharp
- node
- php