{
  "opencollection": "1.0.0",
  "info": {
    "name": "Sinch Numbers API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "https://auth.sinch.com/oauth2/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Available Numbers",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Available Numbers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://numbers.api.sinch.com/v1/projects/:project_id/availableNumbers",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "The unique project identifier"
              },
              {
                "name": "regionCode",
                "value": "",
                "type": "query",
                "description": "The ISO 3166-1 alpha-2 country code"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "The number type to search for"
              },
              {
                "name": "numberPattern.pattern",
                "value": "",
                "type": "query",
                "description": "Pattern to search for in the phone number"
              },
              {
                "name": "numberPattern.searchPattern",
                "value": "",
                "type": "query",
                "description": "Where in the number to search for the pattern"
              },
              {
                "name": "capabilities",
                "value": "",
                "type": "query",
                "description": "Filter by capabilities"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "The maximum number of results to return"
              }
            ]
          },
          "docs": "Searches for available phone numbers that can be purchased. Results can be filtered by country, type, capabilities, number pattern, and region."
        },
        {
          "info": {
            "name": "Get an Available Number",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://numbers.api.sinch.com/v1/projects/:project_id/availableNumbers/:phone_number",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "The unique project identifier"
              },
              {
                "name": "phone_number",
                "value": "",
                "type": "path",
                "description": "The phone number in E.164 format"
              }
            ]
          },
          "docs": "Returns the details of a specific available phone number including its type, capabilities, and pricing."
        },
        {
          "info": {
            "name": "Rent a Number",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://numbers.api.sinch.com/v1/projects/:project_id/availableNumbers/:phone_number:rent",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "The unique project identifier"
              },
              {
                "name": "phone_number",
                "value": "",
                "type": "path",
                "description": "The phone number in E.164 format"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Activates a phone number by renting it for use with Sinch services. The number will be assigned to your project and can be configured for SMS, Voice, or other services."
        }
      ]
    },
    {
      "info": {
        "name": "Active Numbers",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Active Numbers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://numbers.api.sinch.com/v1/projects/:project_id/activeNumbers",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "The unique project identifier"
              },
              {
                "name": "regionCode",
                "value": "",
                "type": "query",
                "description": "The ISO 3166-1 alpha-2 country code"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "The number type"
              },
              {
                "name": "numberPattern.pattern",
                "value": "",
                "type": "query",
                "description": "Pattern to search for"
              },
              {
                "name": "capabilities",
                "value": "",
                "type": "query",
                "description": "Filter by capabilities"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of results per page"
              },
              {
                "name": "pageToken",
                "value": "",
                "type": "query",
                "description": "Pagination token for the next page"
              }
            ]
          },
          "docs": "Returns a list of all active phone numbers in the project with pagination support. Results can be filtered by country, type, and capabilities."
        },
        {
          "info": {
            "name": "Get an Active Number",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://numbers.api.sinch.com/v1/projects/:project_id/activeNumbers/:phone_number",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "The unique project identifier"
              },
              {
                "name": "phone_number",
                "value": "",
                "type": "path",
                "description": "The phone number in E.164 format"
              }
            ]
          },
          "docs": "Returns the configuration and details of a specific active number."
        },
        {
          "info": {
            "name": "Update an Active Number",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://numbers.api.sinch.com/v1/projects/:project_id/activeNumbers/:phone_number",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "The unique project identifier"
              },
              {
                "name": "phone_number",
                "value": "",
                "type": "path",
                "description": "The phone number in E.164 format"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the configuration of an active number including its display name, SMS and voice configurations, and callback URL."
        },
        {
          "info": {
            "name": "Release an Active Number",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://numbers.api.sinch.com/v1/projects/:project_id/activeNumbers/:phone_number:release",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "The unique project identifier"
              },
              {
                "name": "phone_number",
                "value": "",
                "type": "path",
                "description": "The phone number in E.164 format"
              }
            ]
          },
          "docs": "Releases an active number, removing it from your project. The number will no longer be available for use with Sinch services."
        }
      ]
    },
    {
      "info": {
        "name": "Available Regions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Available Regions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://numbers.api.sinch.com/v1/projects/:project_id/availableRegions",
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "path",
                "description": "The unique project identifier"
              },
              {
                "name": "types",
                "value": "",
                "type": "query",
                "description": "Filter by number types"
              }
            ]
          },
          "docs": "Returns a list of available regions and the types of phone numbers that can be provisioned in each region."
        }
      ]
    }
  ],
  "bundled": true
}