Action: Buy Phone Number

Sinch Operation

The Buy phone number action purchases a virtual or local phone number for voice or SMS use through Sinch’s API.

Example User Story

I want to buy a local phone number via Sinch for my new branch, so customers can call or text us using a familiar area code.

Fields

Field Name	Field Type	Required	Description
countryCode	String	Yes	The ISO country code for the phone number (e.g., 'US', 'GB').
regionCode	String	No	The region or state code within the country (e.g., 'CA' for California).
numberType	String	Yes	The type of phone number (e.g., 'MOBILE', 'LOCAL', 'TOLL_FREE').
capabilities	String	Yes	The capabilities required for the number (e.g., 'SMS', 'VOICE', 'SMS,VOICE').

Related Connections

Sinch

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "buy-phone-number",
  "state": "inDev",
  "meta": {
    "short": "Buy Phone Number",
    "description": "Purchase a phone number from Sinch for SMS or voice services."
  },
  "input": [
    {
      "name": "countryCode",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The ISO country code for the phone number (e.g., 'US', 'GB')."
      }
    },
    {
      "name": "regionCode",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The region or state code within the country (e.g., 'CA' for California)."
      }
    },
    {
      "name": "numberType",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The type of phone number (e.g., 'MOBILE', 'LOCAL', 'TOLL_FREE').",
        "options": ["MOBILE", "LOCAL", "TOLL_FREE"]
      }
    },
    {
      "name": "capabilities",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The capabilities required for the number (e.g., 'SMS', 'VOICE', 'SMS,VOICE').",
        "options": ["SMS", "VOICE", "SMS,VOICE"]
      }
    }
  ],
  "output": [
    {
      "name": "phoneNumber",
      "type": "String",
      "selector": ["phoneNumber"],
      "meta": {
        "description": "The purchased phone number in E.164 format."
      }
    },
    {
      "name": "success",
      "type": "Boolean",
      "selector": ["success"],
      "meta": {
        "description": "Indicates whether the purchase was successful."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": "/availableNumbers",
        "headers": {
          "Content-Type": "application/json"
        },
        "bodyTemplate": {
          "value": "{\"countryCode\":\"{{countryCode}}\",\"regionCode\":\"{{regionCode}}\",\"type\":\"{{numberType}}\",\"capabilities\":[\"{{capabilities}}\"]}",
          "placeholders": [
            {
              "name": "accessToken",
              "type": "String",
              "description": "The authentication token for Sinch API.",
              "required": true
            },
            {
              "name": "countryCode",
              "type": "String",
              "description": "The ISO country code for the phone number.",
              "required": true
            },
            {
              "name": "regionCode",
              "type": "String",
              "description": "The region or state code within the country.",
              "required": false
            },
            {
              "name": "numberType",
              "type": "String",
              "description": "The type of phone number.",
              "required": true,
              "options": ["MOBILE", "LOCAL", "TOLL_FREE"]
            },
            {
              "name": "capabilities",
              "type": "String",
              "description": "The capabilities required for the number.",
              "required": true,
              "options": ["SMS", "VOICE", "SMS,VOICE"]
            }
          ]
        }
      }
    }
  ]
}