Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
http.BasicAuth = true;
http.Login = "{{TWILIO_ACCOUNT_SID}}";
http.Password = "{{TWILIO_AUTH_TOKEN}}";
var req = new chilkat.HttpRequest();
req.AddParam("PhoneNumber","+12513060906");
// resp: HttpResponse
var resp = http.PostUrlEncoded("https://api.twilio.com/2010-04-01/Accounts/:AccountSid/IncomingPhoneNumbers.json",req);
if (http.LastMethodSuccess == false) {
console.log(http.LastErrorText);
return;
}
var sbResponseBody = new chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
console.log("Response Body:");
console.log(jResp.Emit());
var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Header:");
console.log(resp.Header);
console.log("Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "account_sid": "ACB6",
// "address_requirements": "foreign",
// "address_sid": "ADeA",
// "api_version": "reprehenderit laborum Excepteur",
// "beta": false,
// "bundle_sid": "BUB2",
// "capabilities": {},
// "date_created": "incididunt ad",
// "date_updated": "consequat nostrud non Excepteur",
// "emergency_address_sid": "ADAd",
// "emergency_status": "Inactive",
// "friendly_name": "Excepteur qui aute occaecat",
// "identity_sid": "RI4F",
// "origin": "ex sit non",
// "phone_number": "incididunt",
// "sid": "PNFd",
// "sms_application_sid": "APD1",
// "sms_fallback_method": "put",
// "sms_fallback_url": "https://sqnVhokvKfX.ggVS",
// "sms_method": "delete",
// "sms_url": "http://KvTTK.eixDOBAKnXDodC",
// "status": "Duis est",
// "status_callback": "https://lukPySBKCSJZRDfZeLGCQEJiiZlrSGtT.slbsog2f2Byb3SNOpnvFCnKiEUbexVWC5tK9Qaj0IFkIVhVKN+mNB826euAwsZOYNBGrdhphsN",
// "status_callback_method": "HEAD",
// "trunk_sid": "TK29",
// "uri": "http://efvlxkNPQlPFtoHjtYEM.qceW6gOSsyL5X8uZPGhiRrpPWucrUmJlQexyf4Dl9T7ahcoPDgC3k2TRG",
// "voice_application_sid": "AP5b",
// "voice_caller_id_lookup": true,
// "voice_fallback_method": "head",
// "voice_fallback_url": "https://YYJSXXIemHJDgyPulvPuSDhUfIJ.ofhsUNmlqzZSTo7nnhXYYLQgunn2ScfFWt4qoJ,M2zYA,",
// "voice_method": "PATCH",
// "voice_receive_mode": "voice",
// "voice_url": "https://lNOljQzheebolftPuuCa.qjzdVdF,m6lXjsq+rV4sijQkntubbHInkrQaJO2zBraF0"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var date_created = new chilkat.DtObj();
var date_updated = new chilkat.DtObj();
var account_sid = jResp.StringOf("account_sid");
var address_requirements = jResp.StringOf("address_requirements");
var address_sid = jResp.StringOf("address_sid");
var api_version = jResp.StringOf("api_version");
var beta = jResp.BoolOf("beta");
var bundle_sid = jResp.StringOf("bundle_sid");
jResp.DtOf("date_created",false,date_created);
jResp.DtOf("date_updated",false,date_updated);
var emergency_address_sid = jResp.StringOf("emergency_address_sid");
var emergency_status = jResp.StringOf("emergency_status");
var friendly_name = jResp.StringOf("friendly_name");
var identity_sid = jResp.StringOf("identity_sid");
var origin = jResp.StringOf("origin");
var phone_number = jResp.StringOf("phone_number");
var sid = jResp.StringOf("sid");
var sms_application_sid = jResp.StringOf("sms_application_sid");
var sms_fallback_method = jResp.StringOf("sms_fallback_method");
var sms_fallback_url = jResp.StringOf("sms_fallback_url");
var sms_method = jResp.StringOf("sms_method");
var sms_url = jResp.StringOf("sms_url");
var status = jResp.StringOf("status");
var status_callback = jResp.StringOf("status_callback");
var status_callback_method = jResp.StringOf("status_callback_method");
var trunk_sid = jResp.StringOf("trunk_sid");
var uri = jResp.StringOf("uri");
var voice_application_sid = jResp.StringOf("voice_application_sid");
var voice_caller_id_lookup = jResp.BoolOf("voice_caller_id_lookup");
var voice_fallback_method = jResp.StringOf("voice_fallback_method");
var voice_fallback_url = jResp.StringOf("voice_fallback_url");
var voice_method = jResp.StringOf("voice_method");
var voice_receive_mode = jResp.StringOf("voice_receive_mode");
var voice_url = jResp.StringOf("voice_url");
}
chilkatExample();
Curl Command
curl -X POST
-u '{{TWILIO_ACCOUNT_SID}}:{{TWILIO_AUTH_TOKEN}}'
-H "Content-Type: application/x-www-form-urlencoded"
--data-urlencode 'PhoneNumber=+12513060906'
https://api.twilio.com/2010-04-01/Accounts/:AccountSid/IncomingPhoneNumbers.json
Postman Collection Item JSON
{
"name": "Buy a phone number",
"event": [
{
"listen": "test",
"script": {
"exec": [
"var jsonData = JSON.parse(responseBody);",
"postman.setEnvironmentVariable('TWILIO_PHONE_NUMBER', jsonData.phone_number);"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{TWILIO_AUTH_TOKEN}}",
"type": "string"
},
{
"key": "username",
"value": "{{TWILIO_ACCOUNT_SID}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "PhoneNumber",
"value": "+12513060906",
"description": "The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234."
},
{
"key": "AddressSid",
"value": "<string>",
"description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.",
"disabled": true
},
{
"key": "ApiVersion",
"value": "<string>",
"description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`.",
"disabled": true
},
{
"key": "AreaCode",
"value": "<string>",
"description": "The desired area code for your new incoming phone number. Can be any three-digit, US or Canada area code. We will provision an available phone number within this area code for you. **You must provide an `area_code` or a `phone_number`.** (US and Canada only).",
"disabled": true
},
{
"key": "BundleSid",
"value": "<string>",
"description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.",
"disabled": true
},
{
"key": "EmergencyAddressSid",
"value": "<string>",
"description": "The SID of the emergency address configuration to use for emergency calling from the new phone number.",
"disabled": true
},
{
"key": "EmergencyStatus",
"value": "<string>",
"description": "The configuration status parameter that determines whether the new phone number is enabled for emergency calling. (This can only be one of Active,Inactive)",
"disabled": true
},
{
"key": "FriendlyName",
"value": "<string>",
"description": "A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the new phone number.",
"disabled": true
},
{
"key": "IdentitySid",
"value": "<string>",
"description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations.",
"disabled": true
},
{
"key": "SmsApplicationSid",
"value": "<string>",
"description": "The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application.",
"disabled": true
},
{
"key": "SmsFallbackMethod",
"value": "<string>",
"description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`. (This can only be one of head,get,post,patch,put,delete,HEAD,GET,POST,PATCH,PUT,DELETE)",
"disabled": true
},
{
"key": "SmsFallbackUrl",
"value": "<uri>",
"description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.",
"disabled": true
},
{
"key": "SmsMethod",
"value": "<string>",
"description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`. (This can only be one of head,get,post,patch,put,delete,HEAD,GET,POST,PATCH,PUT,DELETE)",
"disabled": true
},
{
"key": "SmsUrl",
"value": "<uri>",
"description": "The URL we should call when the new phone number receives an incoming SMS message.",
"disabled": true
},
{
"key": "StatusCallback",
"value": "<uri>",
"description": "The URL we should call using the `status_callback_method` to send status information to your application.",
"disabled": true
},
{
"key": "StatusCallbackMethod",
"value": "<string>",
"description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`. (This can only be one of head,get,post,patch,put,delete,HEAD,GET,POST,PATCH,PUT,DELETE)",
"disabled": true
},
{
"key": "TrunkSid",
"value": "<string>",
"description": "The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.",
"disabled": true
},
{
"key": "VoiceApplicationSid",
"value": "<string>",
"description": "The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.",
"disabled": true
},
{
"key": "VoiceCallerIdLookup",
"value": "<boolean>",
"description": "Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.",
"disabled": true
},
{
"key": "VoiceFallbackMethod",
"value": "<string>",
"description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`. (This can only be one of head,get,post,patch,put,delete,HEAD,GET,POST,PATCH,PUT,DELETE)",
"disabled": true
},
{
"key": "VoiceFallbackUrl",
"value": "<uri>",
"description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.",
"disabled": true
},
{
"key": "VoiceMethod",
"value": "<string>",
"description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`. (This can only be one of head,get,post,patch,put,delete,HEAD,GET,POST,PATCH,PUT,DELETE)",
"disabled": true
},
{
"key": "VoiceReceiveMode",
"value": "<string>",
"description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`. (This can only be one of voice,fax)",
"disabled": true
},
{
"key": "VoiceUrl",
"value": "<uri>",
"description": "The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.",
"disabled": true
}
]
},
"url": {
"raw": "{{2010-04-01-Accounts-AccountSid-IncomingPhoneNumbers.json-Url}}/2010-04-01/Accounts/:AccountSid/IncomingPhoneNumbers.json",
"host": [
"{{2010-04-01-Accounts-AccountSid-IncomingPhoneNumbers.json-Url}}"
],
"path": [
"2010-04-01",
"Accounts",
":AccountSid",
"IncomingPhoneNumbers.json"
],
"variable": [
{
"key": "AccountSid",
"value": "{{TWILIO_ACCOUNT_SID}}",
"description": "(Required) The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource."
}
]
},
"description": "Purchase a phone-number for your Twilio account. Afterwards you can use this number to send or receive SMS and calls.\n\nRead more about it in the [Twilio Docs](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource#create-an-incomingphonenumber-resource)"
},
"response": [
{
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "AddressSid",
"value": "<string>",
"description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations."
},
{
"key": "ApiVersion",
"value": "<string>",
"description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`."
},
{
"key": "AreaCode",
"value": "<string>",
"description": "The desired area code for your new incoming phone number. Can be any three-digit, US or Canada area code. We will provision an available phone number within this area code for you. **You must provide an `area_code` or a `phone_number`.** (US and Canada only)."
},
{
"key": "BundleSid",
"value": "<string>",
"description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations."
},
{
"key": "EmergencyAddressSid",
"value": "<string>",
"description": "The SID of the emergency address configuration to use for emergency calling from the new phone number."
},
{
"key": "EmergencyStatus",
"value": "<string>",
"description": "The configuration status parameter that determines whether the new phone number is enabled for emergency calling. (This can only be one of Active,Inactive)"
},
{
"key": "FriendlyName",
"value": "<string>",
"description": "A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the new phone number."
},
{
"key": "IdentitySid",
"value": "<string>",
"description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations."
},
{
"key": "PhoneNumber",
"value": "<string>",
"description": "The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234."
},
{
"key": "SmsApplicationSid",
"value": "<string>",
"description": "The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application."
},
{
"key": "SmsFallbackMethod",
"value": "<string>",
"description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`. (This can only be one of head,get,post,patch,put,delete,HEAD,GET,POST,PATCH,PUT,DELETE)"
},
{
"key": "SmsFallbackUrl",
"value": "<uri>",
"description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`."
},
{
"key": "SmsMethod",
"value": "<string>",
"description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`. (This can only be one of head,get,post,patch,put,delete,HEAD,GET,POST,PATCH,PUT,DELETE)"
},
{
"key": "SmsUrl",
"value": "<uri>",
"description": "The URL we should call when the new phone number receives an incoming SMS message."
},
{
"key": "StatusCallback",
"value": "<uri>",
"description": "The URL we should call using the `status_callback_method` to send status information to your application."
},
{
"key": "StatusCallbackMethod",
"value": "<string>",
"description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`. (This can only be one of head,get,post,patch,put,delete,HEAD,GET,POST,PATCH,PUT,DELETE)"
},
{
"key": "TrunkSid",
"value": "<string>",
"description": "The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa."
},
{
"key": "VoiceApplicationSid",
"value": "<string>",
"description": "The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa."
},
{
"key": "VoiceCallerIdLookup",
"value": "<boolean>",
"description": "Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`."
},
{
"key": "VoiceFallbackMethod",
"value": "<string>",
"description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`. (This can only be one of head,get,post,patch,put,delete,HEAD,GET,POST,PATCH,PUT,DELETE)"
},
{
"key": "VoiceFallbackUrl",
"value": "<uri>",
"description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`."
},
{
"key": "VoiceMethod",
"value": "<string>",
"description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`. (This can only be one of head,get,post,patch,put,delete,HEAD,GET,POST,PATCH,PUT,DELETE)"
},
{
"key": "VoiceReceiveMode",
"value": "<string>",
"description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`. (This can only be one of voice,fax)"
},
{
"key": "VoiceUrl",
"value": "<uri>",
"description": "The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set."
}
]
},
"url": {
"raw": "{{2010-04-01-Accounts-AccountSid-IncomingPhoneNumbers.json-Url}}/2010-04-01/Accounts/:AccountSid/IncomingPhoneNumbers.json",
"host": [
"{{2010-04-01-Accounts-AccountSid-IncomingPhoneNumbers.json-Url}}"
],
"path": [
"2010-04-01",
"Accounts",
":AccountSid",
"IncomingPhoneNumbers.json"
],
"variable": [
{
"key": "AccountSid"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"account_sid\": \"ACB6\",\n \"address_requirements\": \"foreign\",\n \"address_sid\": \"ADeA\",\n \"api_version\": \"reprehenderit laborum Excepteur\",\n \"beta\": false,\n \"bundle_sid\": \"BUB2\",\n \"capabilities\": {},\n \"date_created\": \"incididunt ad\",\n \"date_updated\": \"consequat nostrud non Excepteur\",\n \"emergency_address_sid\": \"ADAd\",\n \"emergency_status\": \"Inactive\",\n \"friendly_name\": \"Excepteur qui aute occaecat\",\n \"identity_sid\": \"RI4F\",\n \"origin\": \"ex sit non\",\n \"phone_number\": \"incididunt\",\n \"sid\": \"PNFd\",\n \"sms_application_sid\": \"APD1\",\n \"sms_fallback_method\": \"put\",\n \"sms_fallback_url\": \"https://sqnVhokvKfX.ggVS\",\n \"sms_method\": \"delete\",\n \"sms_url\": \"http://KvTTK.eixDOBAKnXDodC\",\n \"status\": \"Duis est\",\n \"status_callback\": \"https://lukPySBKCSJZRDfZeLGCQEJiiZlrSGtT.slbsog2f2Byb3SNOpnvFCnKiEUbexVWC5tK9Qaj0IFkIVhVKN+mNB826euAwsZOYNBGrdhphsN\",\n \"status_callback_method\": \"HEAD\",\n \"trunk_sid\": \"TK29\",\n \"uri\": \"http://efvlxkNPQlPFtoHjtYEM.qceW6gOSsyL5X8uZPGhiRrpPWucrUmJlQexyf4Dl9T7ahcoPDgC3k2TRG\",\n \"voice_application_sid\": \"AP5b\",\n \"voice_caller_id_lookup\": true,\n \"voice_fallback_method\": \"head\",\n \"voice_fallback_url\": \"https://YYJSXXIemHJDgyPulvPuSDhUfIJ.ofhsUNmlqzZSTo7nnhXYYLQgunn2ScfFWt4qoJ,M2zYA,\",\n \"voice_method\": \"PATCH\",\n \"voice_receive_mode\": \"voice\",\n \"voice_url\": \"https://lNOljQzheebolftPuuCa.qjzdVdF,m6lXjsq+rV4sijQkntubbHInkrQaJO2zBraF0\"\n}"
}
]
}
