Twilio Docs

https://www.twilio.com/docs
Admin
Twilio Docs provides API reference documentation, quickstarts, SDKs, and code samples to help...
Tokens:346,770
Snippets:1,895
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Develop Locally: Install CLI, init project, and start server

Source: https://www.twilio.com/docs/serverless/functions-assets

Commands to install the Twilio CLI and Serverless plugin, then initialize a new project named my-app and start the local development server. This is the 'Develop and run locally' method for creating an app from scratch.

```bash
# Install the Twilio CLI
npm install -g twilio-cli
# Install the Serverless plugin
twilio plugins:install @twilio-labs/plugin-serverless

# Initialize a new project with the name my-app
twilio serverless:init my-app
cd my-app

# Now you're ready to develop and interact with your app locally!
twilio serverless:start
```

--------------------------------

### Initialize project and install dependencies

Source: https://www.twilio.com/docs/openapi/mock-api-generation-with-twilio-openapi-spec

Initializes a new Node.js project and installs the Twilio SDK and dotenv. Also creates the index.js and .env files needed for the example.

```shell
yarn init -y
# Or if you prefer npm
npm init -y

# Once initialized, install dependencies!
yarn add twilio dotenv
# Or with npm
npm i twilio dotenv

# Create a new js file as well as a safe file for credentials and other sensitive variables to live in
touch index.js .env
```

--------------------------------

### Prism mock server startup output

Source: https://www.twilio.com/docs/openapi/mock-api-generation-with-twilio-openapi-spec

Example output after starting the Prism mock server. The green 'start' line indicates the server is running and listening on port 4010.

```bash
$ prism mock https://raw.githubusercontent.com/twilio/twilio-oai/main/spec/json/twilio_api_v2010.json

› [CLI] …  awaiting  Starting Prism…
› [CLI] ℹ  info      GET        http://127.0.0.1:4010/2010-04-01/Accounts.json?FriendlyName=omnis&Status=suspended&PageSize=801
› [CLI] ℹ  info      POST       http://127.0.0.1:4010/2010-04-01/Accounts.json
› [CLI] ℹ  info      GET        http://127.0.0.1:4010/2010-04-01/Accounts/ACbC8dB063DcfAe78a6D0cfEb09e0c7c7a/Addresses.json?CustomerName=doloribus&FriendlyName=porro&IsoCountry=necessitatibus&PageSize=325
…
› [CLI] ℹ  info      GET        http://127.0.0.1:4010/2010-04-01/Accounts/ACF5ce8F97eb3E0270a856d8539e61DAE5.json
› [CLI] ℹ  info      POST       http://127.0.0.1:4010/2010-04-01/Accounts/AC61FCB0720E02eCAf7fEeCbafEa602aE5.json
› [CLI] ▶  start     Prism is listening on http://127.0.0.1:4010
```

--------------------------------

### Example output from running node example.js

Source: https://www.twilio.com/docs/openapi/mock-api-generation-with-twilio-openapi-spec

Expected output when running the example. The null SID indicates Prism successfully intercepted the request.

```shell
$ node example.js
Message null sent!
```

--------------------------------

### GET /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json

Source: https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource

This snippet documents the HTTP GET endpoint for listing IncomingPhoneNumber resources, including the curl example and response structure.

```APIDOC
## [GET] /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json

### Description
Retrieves a list of IncomingPhoneNumber resources associated with the specified account. This endpoint supports pagination and filtering via query parameters.

### Method
GET

### Endpoint
`/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json`

### Parameters
#### Path Parameters
- **AccountSid** (string) - Required - The SID of the Account that owns the IncomingPhoneNumber resources.

#### Query Parameters
- **PageSize** (integer) - Optional - The number of records to return per page. In the example, `PageSize=20` is used.

### Request Example
```
curl -X GET "https://api.twilio.com/2010-04-01/Accounts/$TWILIO_ACCOUNT_SID/IncomingPhoneNumbers.json?PageSize=20" \
-u $TWILIO_API_KEY:$TWILIO_API_SECRET
```

### Response
#### Success Response (200)
- **incoming_phone_numbers** (array) - List of IncomingPhoneNumber resources.
- **end** (string) - The end date of the phone number's usage or subscription.

#### Response Example
```json
{
  "incoming_phone_numbers": [
    {
      "end": "2023-01-01"
    }
  ]
}
```
```

--------------------------------

### Quick-Deploy: Install CLI, init template, and deploy

Source: https://www.twilio.com/docs/serverless/functions-assets

Commands to install the Twilio CLI and Serverless plugin, then initialize a new project from the hello-messaging template and deploy it. This is the quick-deploy method for bootstrapping a functional app.

```bash
# Install the Twilio CLI
npm install -g twilio-cli
# Install the Serverless plugin
twilio plugins:install @twilio-labs/plugin-serverless

# Initialize a new project based off of a pre-configured
# template and configure it
twilio serverless:init example --template=hello-messaging
cd example

# Deploy your app in seconds!
twilio serverless:deploy
```

--------------------------------

### GET /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json

Source: https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource

This snippet documents the HTTP GET endpoint for listing incoming phone numbers, including query parameters and a curl example.

```APIDOC
## [GET] /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json

### Description
Lists all incoming phone numbers for the account, optionally filtered by phone number. This endpoint returns a list of IncomingPhoneNumber resources.

### Method
GET

### Endpoint
`/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json`

### Parameters
#### Path Parameters
- **AccountSid** (string) - Required - The Account SID that owns the IncomingPhoneNumber resources.

#### Query Parameters
- **PhoneNumber** (string) - Optional - Filter by the phone number (e.g., "867").
- **PageSize** (integer) - Optional - The maximum number of records to return (e.g., 20).

### Request Example
```
curl -X GET "https://api.twilio.com/2010-04-01/Accounts/$TWILIO_ACCOUNT_SID/IncomingPhoneNumbers.json?PhoneNumber=867&PageSize=20" \
-u $TWILIO_API_KEY:$TWILIO_API_SECRET
```

### Response
#### Success Response (200)
- **incoming_phone_numbers** (array) - List of IncomingPhoneNumber resources.
- **end** (string) - The end date of the phone number (example field from the code).

#### Response Example
```
{
  "incoming_phone_numbers": [
    {
      "end": "2021-01-01"
    }
  ]
}
```
```

--------------------------------

### GET /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json

Source: https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource

This snippet documents the HTTP GET request to list incoming phone numbers, including query parameters and an example using curl.

```APIDOC
## [GET] /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json

### Description
Retrieves a list of incoming phone numbers associated with the account, optionally filtered by phone number.

### Method
GET

### Endpoint
`/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json`

### Parameters
#### Path Parameters
- **AccountSid** (string) - Required - The unique SID identifier of the account.

#### Query Parameters
- **PhoneNumber** (string) - Optional - The phone number to filter the list by.
- **PageSize** (integer) - Optional - The number of records to return per page.

### Request Example
```
curl -X GET "https://api.twilio.com/2010-04-01/Accounts/$TWILIO_ACCOUNT_SID/IncomingPhoneNumbers.json?PhoneNumber=%2B14158675310&PageSize=20" \
-u $TWILIO_API_KEY:$TWILIO_API_SECRET
```

### Response
#### Success Response (200)
Returns a list of incoming phone number records. Each record contains an `end` field indicating the end of the list.

#### Response Example
```json
{
  "incoming_phone_numbers": [
    {
      "end": "..."
    }
  ]
}
```
```

--------------------------------

### List Services with C# / .NET

Source: https://www.twilio.com/docs/notify/api/service-resource

C# / .NET example using the Twilio helper library to list up to 20 Service resources. Requires TWILIO_ACCOUNT_SID, TWILIO_API_KEY, and TWILIO_API_SECRET environment variables.

```csharp
// Install the C# / .NET helper library from twilio.com/docs/csharp/install

using System;
using Twilio;
using Twilio.Rest.Notify.V1;
using System.Threading.Tasks;

class Program {
    public static async Task Main(string[] args) {
        // Find your Account SID at twilio.com/console
        // Provision API Keys at twilio.com/console/runtime/api-keys
        // and set the environment variables. See http://twil.io/secure
        // For local testing, you can use your Account SID and Auth token
        string apiKey = Environment.GetEnvironmentVariable("TWILIO_API_KEY");
        string apiSecret = Environment.GetEnvironmentVariable("TWILIO_API_SECRET");
        string accountSid = Environment.GetEnvironmentVariable("TWILIO_ACCOUNT_SID");

        TwilioClient.Init(apiKey, apiSecret, accountSid);

        var services = await ServiceResource.ReadAsync(limit: 20);

        foreach (var record in services) {
            Console.WriteLine(record.Sid);
        }
    }
}
```

--------------------------------

### Response for get all port-in requests

Source: https://www.twilio.com/docs/phone-numbers/port-in/port-in-request-api

Example response for the GET all port-in requests endpoint. Shows the structure with port_in_requests array and meta object containing next_token and previous_token.

```json
{
  "port_in_requests": [
    {
      "port_in_request_sid": "KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "port_in_request_status": "Completed",
      "status_last_updated_timestamp": "2025-04-30",
      "phone_numbers_requested": 1,
      "phone_numbers_ported": 0,
      "suggested_action": null
    }
  ],
  "meta": {
    "next_token": "KWbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
    "previous_token": null
  }
}
```

--------------------------------

### GET /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json

Source: https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource

Documentation for the GET endpoint that reads multiple IncomingPhoneNumber resources, including path and query parameters and code examples in Node.js, Python, and C#.

```APIDOC
## GET /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json

### Description
Reads multiple IncomingPhoneNumber resources for the specified account. Supports filtering by Beta, FriendlyName, PhoneNumber, and Origin, and pagination via PageSize, Page, and PageToken.

### Method
GET

### Endpoint
`https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json`

### Parameters
#### Path Parameters
- **AccountSid** (string) - Required - The SID of the Account that created the IncomingPhoneNumber resources to read. Must match pattern `^AC[0-9a-fA-F]{32}$` and be 34 characters long.

#### Query Parameters
- **Beta** (boolean) - Optional - Whether to include phone numbers new to the Twilio platform. Can be `true` or `false`; default is `true`.
- **FriendlyName** (string) - Optional - A string that identifies the IncomingPhoneNumber resources to read.
- **PhoneNumber** (string) - Optional - The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.
- **Origin** (string) - Optional - Whether to include phone numbers based on their origin. Can be `twilio` or `hosted`. By default, phone numbers of all origin are included.
- **PageSize** (integer) - Optional - How many resources to return in each list page. Default is 50, maximum is 1000.
- **Page** (integer) - Optional - The page index. This value is simply for client state.
- **PageToken** (string) - Optional - The page token. This is provided by the API.

### Request Example
No request body is required for this GET request.

### Response
#### Success Response (200)
Returns a list of IncomingPhoneNumber resources. The response includes standard list pagination fields and an array of IncomingPhoneNumber objects.

#### Response Example
No explicit response example is provided in the source documentation.
```

--------------------------------

### List Services with Java

Source: https://www.twilio.com/docs/notify/api/service-resource

Java example using the Twilio helper library to list up to 20 Service resources. Requires TWILIO_ACCOUNT_SID, TWILIO_API_KEY, and TWILIO_API_SECRET environment variables.

```java
// Install the Java helper library from twilio.com/docs/java/install

import com.twilio.Twilio;
import com.twilio.rest.notify.v1.Service;
import com.twilio.base.ResourceSet;

public class Example {
    // Find your Account SID at twilio.com/console
    // Provision API Keys at twilio.com/console/runtime/api-keys
    // and set the environment variables. See http://twil.io/secure
    // For local testing, you can use your Account SID and Auth token
    public static final String API_KEY = System.getenv("TWILIO_API_KEY");
    public static final String API_SECRET = System.getenv("TWILIO_API_SECRET");
    public static final String ACCOUNT_SID = System.getenv("TWILIO_ACCOUNT_SID");

    public static void main(String[] args) {
        Twilio.init(API_KEY, API_SECRET, ACCOUNT_SID);
        ResourceSet<Service> services = Service.reader().limit(20).read();

        for (Service record : services) {
            System.out.println(record.getSid());
        }
    }
}
```

--------------------------------

### List Services with Python

Source: https://www.twilio.com/docs/notify/api/service-resource

Python example using the Twilio helper library to list up to 20 Service resources. Requires TWILIO_ACCOUNT_SID, TWILIO_API_KEY, and TWILIO_API_SECRET environment variables.

```python
# Download the helper library from https://www.twilio.com/docs/python/install
import os
from twilio.rest import Client

# Find your Account SID at twilio.com/console
# Provision API Keys at twilio.com/console/runtime/api-keys
# and set the environment variables. See http://twil.io/secure
# For local testing, you can use your Account SID and Auth token
api_key = os.environ["TWILIO_API_KEY"]
api_secret = os.environ["TWILIO_API_SECRET"]
account_sid = os.environ["TWILIO_ACCOUNT_SID"]
client = Client(api_key, api_secret, account_sid)

services = client.notify.v1.services.list(limit=20)

for record in services:
    print(record.sid)
```

--------------------------------

### Get Webhook Configuration Response

Source: https://www.twilio.com/docs/phone-numbers/port-in/porting-webhooks

Example response from the GET webhook configuration request. Shows the target URLs for port-in and port-out, the list of notification types, and creation timestamps.

```JSON
{
  "port_in_target_url": "https://www.example.com/port-in",
  "port_out_target_url": "https://www.example.com/port-out",
  "notifications_of": [
    "PortInWaitingForSignature",
    "PortInInProgress",
    "PortInCompleted",
    "PortInActionRequired",
    "PortInCanceled",
    "PortInExpired",
    "PortInPhoneNumberWaitingForSignature",
    "PortInPhoneNumberSubmitted",
    "PortInPhoneNumberPending",
    "PortInPhoneNumberCompleted",
    "PortInPhoneNumberRejected",
    "PortOutPhoneNumberCompleted"
  ],
  "port_in_target_date_created": "2024-05-14T13:49:04Z",
  "port_out_target_date_created": "2024-05-14T13:49:07Z",
  "url": "https://numbers.twilio.com/v1/Porting/Configuration/Webhook"
}
```

--------------------------------

### Fetch Service with C#

Source: https://www.twilio.com/docs/notify/api/service-resource

C# example using the Twilio helper library to fetch a Service resource. Requires TWILIO_API_KEY, TWILIO_API_SECRET, and TWILIO_ACCOUNT_SID environment variables. Prints the service Sid.

```csharp
// Install the C# / .NET helper library from twilio.com/docs/csharp/install

using System;
using Twilio;
using Twilio.Rest.Notify.V1;
using System.Threading.Tasks;

class Program {
    public static async Task Main(string[] args) {
        // Find your Account SID at twilio.com/console
        // Provision API Keys at twilio.com/console/runtime/api-keys
        // and set the environment variables. See http://twil.io/secure
        // For local testing, you can use your Account SID and Auth token
        string apiKey = Environment.GetEnvironmentVariable("TWILIO_API_KEY");
        string apiSecret = Environment.GetEnvironmentVariable("TWILIO_API_SECRET");
        string accountSid = Environment.GetEnvironmentVariable("TWILIO_ACCOUNT_SID");

        TwilioClient.Init(apiKey, apiSecret, accountSid);

        var service =
            await ServiceResource.FetchAsync(pathSid: "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa");

        Console.WriteLine(service.Sid);
    }
}
```

--------------------------------

### GET /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Local.json

Source: https://www.twilio.com/docs/phone-numbers/api/availablephonenumberlocal-resource

This code snippet documents the GET endpoint for listing available local phone numbers, including all query parameters and an example request.

```APIDOC
## GET /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Local.json

### Description
Returns a list of available local phone numbers for a given country, with optional filters such as area code, locality, and capabilities.

### Method
GET

### Endpoint
`/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Local.json`

### Parameters
#### Path Parameters
- **AccountSid** (string) - Required - The Account SID that owns the phone numbers.
- **CountryCode** (string) - Required - The ISO country code for the phone numbers (e.g., US).

#### Query Parameters
- **AreaCode** (integer) - Optional - The area code of the phone numbers to find.
- **Contains** (string) - Optional - A pattern to match phone numbers.
- **SmsEnabled** (boolean) - Optional - Whether the phone numbers can receive SMS messages.
- **MmsEnabled** (boolean) - Optional - Whether the phone numbers can receive MMS messages.
- **VoiceEnabled** (boolean) - Optional - Whether the phone numbers can receive calls.
- **ExcludeAllAddressRequired** (boolean) - Optional - Whether to exclude phone numbers that require an address.
- **ExcludeLocalAddressRequired** (boolean) - Optional - Whether to exclude phone numbers that require a local address.
- **ExcludeForeignAddressRequired** (boolean) - Optional - Whether to exclude phone numbers that require a foreign address.
- **Beta** (boolean) - Optional - Whether to include phone numbers new to the Twilio platform.
- **NearNumber** (string) - Optional - Given a phone number, find a geographically close number within the same LATA.
- **NearLatLong** (string) - Optional - Given a latitude/longitude pair, find a geographically close number.
- **Distance** (integer) - Optional - The search radius, in miles, for a `Near` query.
- **InPostalCode** (string) - Optional - Limit results to a particular postal code.
- **InRegion** (string) - Optional - Limit results to a particular region.
- **InRateCenter** (string) - Optional - Limit results to a particular rate center.
- **InLata** (string) - Optional - Limit results to a particular LATA.
- **InLocality** (string) - Optional - Limit results to a particular locality or city.
- **FaxEnabled** (boolean) - Optional - Whether the phone numbers can receive faxes.
- **PageSize** (integer) - Optional - How many resources to return in each list page. Default is 50, maximum is 1000.
- **Page** (integer) - Optional - The page index. This value is simply for client state.
- **PageToken** (string) - Optional - The page token. This is provided by the API.

### Request Example
```
GET /2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/AvailablePhoneNumbers/US/Local.json?AreaCode=510&PageSize=20
```

### Response
#### Success Response (200)
Returns a list of available local phone numbers with their properties.

#### Response Example
```json
{
  "available_phone_numbers": [
    {
      "phone_number": "+15105551234",
      "friendly_name": "(510) 555-1234",
      "locality": "Oakland",
      "region": "CA",
      "postal_code": "94612",
      "rate_center": "OAKLAND",
      "latitude": 37.8044,
      "longitude": -122.2712,
      "capabilities": {
        "voice": true,
        "SMS": true,
        "MMS": true
      }
    }
  ]
}
```
```

--------------------------------

### Fetch a Credential with Go

Source: https://www.twilio.com/docs/notify/api/credential-resource

Go example using the Twilio helper library to fetch a Credential resource. Requires TWILIO_ACCOUNT_SID, TWILIO_API_KEY, and TWILIO_API_SECRET environment variables.

```go
// Download the helper library from https://www.twilio.com/docs/go/install
package main

import (
	"fmt"
	"github.com/twilio/twilio-go"
	"os"
)

func main() {
	// Find your Account SID at twilio.com/console
	// Provision API Keys at twilio.com/console/runtime/api-keys
	// and set the environment variables. See http://twil.io/secure
	// For local testing, you can use your Account SID and Auth token
	accountSid := os.Getenv("TWILIO_ACCOUNT_SID")
	apiKey := os.Getenv("TWILIO_API_KEY")
	apiSecret := os.Getenv("TWILIO_API_SECRET")
	client := twilio.NewRestClientWithParams(twilio.ClientParams{
		Username:   apiKey,
		Password:   apiSecret,
		AccountSid: accountSid,
	})

	resp, err := client.NotifyV1.FetchCredential("CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
	if err != nil {
		fmt.Println(err.Error())
		os.Exit(1)
	} else {
		if resp.Sid != nil {
			fmt.Println(*resp.Sid)
		} else {
			fmt.Println(resp.Sid)
		}
	}
}
```

--------------------------------

### Run Stoplight Prism mock server with Docker

Source: https://www.twilio.com/docs/openapi/mock-api-generation-with-twilio-openapi-spec

Starts the Stoplight Prism mock server in a Docker container, mapping port 4010 and using the Twilio API v2010 spec. Ensure no other Prism process is using port 4010 or the container will fail to start.

```shell
docker run --init -d -p 4010:4010 stoplight/prism:4 mock -h 0.0.0.0 https://raw.githubusercontent.com/twilio/twilio-oai/main/spec/json/twilio_api_v2010.json
```

--------------------------------

### Search available phone numbers by pattern (contains %979%)

Source: https://www.twilio.com/docs/phone-numbers/api/availablephonenumberlocal-resource

Find local available phone numbers in the US containing "%979%" using the Twilio API. Each example shows the required helper library installation and environment variable setup, then filters results with the "contains" pattern and limits to 20 records, printing each returned phone number.

```csharp
// Install the C# / .NET helper library from twilio.com/docs/csharp/install

using System;
using Twilio;
using Twilio.Rest.Api.V2010.Account.AvailablePhoneNumberCountry;
using System.Threading.Tasks;

class Program {
    public static async Task Main(string[] args) {
        // Find your Account SID at twilio.com/console
        // Provision API Keys at twilio.com/console/runtime/api-keys
        // and set the environment variables. See http://twil.io/secure
        // For local testing, you can use your Account SID and Auth token
        string apiKey = Environment.GetEnvironmentVariable("TWILIO_API_KEY");
        string apiSecret = Environment.GetEnvironmentVariable("TWILIO_API_SECRET");
        string accountSid = Environment.GetEnvironmentVariable("TWILIO_ACCOUNT_SID");

        TwilioClient.Init(apiKey, apiSecret, accountSid);

        var locals =
            await LocalResource.ReadAsync(pathCountryCode: "US", contains: "%979%", limit: 20);

        foreach (var record in locals) {
            Console.WriteLine(record.End);
        }
    }
}
```

```java
// Install the Java helper library from twilio.com/docs/java/install

import com.twilio.Twilio;
import com.twilio.rest.api.v2010.account.availablephonenumbercountry.Local;
import com.twilio.base.ResourceSet;

public class Example {
    // Find your Account SID at twilio.com/console
    // Provision API Keys at twilio.com/console/runtime/api-keys
    // and set the environment variables. See http://twil.io/secure
    // For local testing, you can use your Account SID and Auth token
    public static final String API_KEY = System.getenv("TWILIO_API_KEY");
    public static final String API_SECRET = System.getenv("TWILIO_API_SECRET");
    public static final String ACCOUNT_SID = System.getenv("TWILIO_ACCOUNT_SID");

    public static void main(String[] args) {
        Twilio.init(API_KEY, API_SECRET, ACCOUNT_SID);
        ResourceSet<Local> locals = Local.reader("US").setContains("%979%").limit(20).read();

        for (Local record : locals) {
            System.out.println(record.getEnd());
        }
    }
}
```

```go
// Download the helper library from https://www.twilio.com/docs/go/install
package main

import (
	"fmt"
	"github.com/twilio/twilio-go"
	api "github.com/twilio/twilio-go/rest/api/v2010"
	"os"
)

func main() {
	// Find your Account SID at twilio.com/console
	// Provision API Keys at twilio.com/console/runtime/api-keys
	// and set the environment variables. See http://twil.io/secure
	// For local testing, you can use your Account SID and Auth token
	accountSid := os.Getenv("TWILIO_ACCOUNT_SID")
	apiKey := os.Getenv("TWILIO_API_KEY")
	apiSecret := os.Getenv("TWILIO_API_SECRET")
	client := twilio.NewRestClientWithParams(twilio.ClientParams{
		Username:   apiKey,
		Password:   apiSecret,
		AccountSid: accountSid,
	})

	params := &api.ListAvailablePhoneNumberLocalParams{}
	params.SetContains("%979%")
	params.SetLimit(20)

	resp, err := client.Api.ListAvailablePhoneNumberLocal("US",
		params)
	if err != nil {
		fmt.Println(err.Error())
		os.Exit(1)
	} else {
		for record := range resp {
			if resp[record].End != nil {
				fmt.Println(*resp[record].End)
			} else {
				fmt.Println(resp[record].End)
			}
		}
	}
}
```

```php
<?php

// Update the path below to your autoload.php,
// see https://getcomposer.org/doc/01-basic-usage.md
require_once "/path/to/vendor/autoload.php";

use Twilio\Rest\Client;

// Find your Account SID at twilio.com/console
// Provision API Keys at twilio.com/console/runtime/api-keys
// and set the environment variables. See http://twil.io/secure
// For local testing, you can use your Account SID and Auth token
$apiKey = $_ENV["TWILIO_API_KEY"];
$apiSecret = $_ENV["TWILIO_API_SECRET"];
$sid = $_ENV["TWILIO_ACCOUNT_SID"];
$twilio = new Client($apiKey, $apiSecret, $sid);

$locals = $twilio
    ->availablePhoneNumbers("US")
    ->local->read(["contains" => "%979%"], 20);

foreach ($locals as $record) {
    print $record->end;
}
```

```ruby
# Download the helper library from https://www.twilio.com/docs/ruby/install
require 'twilio-ruby'

# Find your Account SID at twilio.com/console
# Provision API Keys at twilio.com/console/runtime/api-keys
# and set the environment variables. See http://twil.io/secure
# For local testing, you can use your Account SID and Auth token
api_key = ENV['TWILIO_API_KEY']
api_secret = ENV['TWILIO_API_SECRET']
account_sid = ENV['TWILIO_ACCOUNT_SID']
@client = Twilio::REST::Client.new(api_key, api_secret, account_sid)

locals = @client
         .api
         .v2010
         .available_phone_numbers('US')
         .local
         .list(
           contains: '%979%',
           limit: 20
         )

locals.each do |record|
   puts record.end
end
```

```bash
# Install the twilio-cli from https://twil.io/cli

twilio api:core:available-phone-numbers:local:list \
   --country-code US \
   --contains %979%
```

--------------------------------

### Fetch Service with Python

Source: https://www.twilio.com/docs/notify/api/service-resource

Python example using the Twilio helper library to fetch a Service resource. Requires TWILIO_API_KEY, TWILIO_API_SECRET, and TWILIO_ACCOUNT_SID environment variables. Prints the service sid.

```python
# Download the helper library from https://www.twilio.com/docs/python/install
import os
from twilio.rest import Client

# Find your Account SID at twilio.com/console
# Provision API Keys at twilio.com/console/runtime/api-keys
# and set the environment variables. See http://twil.io/secure
# For local testing, you can use your Account SID and Auth token
api_key = os.environ["TWILIO_API_KEY"]
api_secret = os.environ["TWILIO_API_SECRET"]
account_sid = os.environ["TWILIO_ACCOUNT_SID"]
client = Client(api_key, api_secret, account_sid)

service = client.notify.v1.services(
    "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
).fetch()

print(service.sid)
```

--------------------------------

### GET /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json

Source: https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource

This snippet documents the HTTP GET endpoint for fetching an available phone number country resource, including the curl request and JSON response example.

```APIDOC
## GET /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json

### Description
Fetches details about a specific country's available phone number resource, including whether it is in beta and subresource URIs for local and toll-free numbers.

### Method
GET

### Endpoint
`/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json`

### Parameters
#### Path Parameters
- **AccountSid** (string) - Required - The Account SID that owns the phone number resource.
- **CountryCode** (string) - Required - The ISO country code for the country to fetch (e.g., US).

### Request Example
```
curl -X GET "https://api.twilio.com/2010-04-01/Accounts/$TWILIO_ACCOUNT_SID/AvailablePhoneNumbers/US.json" \
-u $TWILIO_API_KEY:$TWILIO_API_SECRET
```

### Response
#### Success Response (200)
- **beta** (boolean) - Indicates whether the country is in beta.
- **country** (string) - The name of the country.
- **country_code** (string) - The ISO country code.
- **subresource_uris** (object) - Contains URIs for local and toll-free subresources.
- **uri** (string) - The URI of the current resource.

#### Response Example
```json
{
  "beta": false,
  "country": "United States",
  "country_code": "US",
  "subresource_uris": {
    "local": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Local.json",
    "toll_free": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/TollFree.json"
  },
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US.json"
}
```
```

--------------------------------

### GET /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountryCode}/Mobile.json

Source: https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-mobile-resource

This snippet documents the GET request to search for available mobile phone numbers in a specific country using the Twilio Phone Numbers API. It includes the endpoint, parameters, and an example request.

```APIDOC
## [GET] /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountryCode}/Mobile.json

### Description
Searches for available mobile phone numbers in a specific country that match the given criteria. This endpoint is part of the Twilio Phone Numbers API and is used to find numbers that can be purchased.

### Method
GET

### Endpoint
`https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountryCode}/Mobile.json`

### Parameters
#### Path Parameters
- **AccountSid** (string) - Required - The unique SID of the Account responsible for the available phone numbers.
- **IsoCountryCode** (string) - Required - The ISO country code of the country from which to retrieve available phone numbers (e.g., `GB`).

#### Query Parameters
- **Contains** (string) - Optional - A string that must appear in the phone number being returned.
- **PageSize** (integer) - Optional - The number of phone number resources to return in the list.

### Request Example
```bash
curl -X GET "https://api.twilio.com/2010-04-01/Accounts/$TWILIO_ACCOUNT_SID/AvailablePhoneNumbers/GB/Mobile.json?Contains=STORM&PageSize=20" \
-u $TWILIO_API_KEY:$TWILIO_API_SECRET
```

### Response
#### Success Response (200)
Returns a list of available mobile phone numbers that match the query parameters. The response includes phone number details such as the phone number, friendly name, and other metadata.

#### Response Example
```json
{
  "available_phone_numbers": [
    {
      "phone_number": "+447700900123",
      "friendly_name": "(700) 900-0123",
      "locality": "London",
      "region": "United Kingdom",
      "country": "GB",
      "capabilities": {
        "voice": true,
        "SMS": true,
        "MMS": false
      }
    }
  ],
  "uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/AvailablePhoneNumbers/GB/Mobile.json?Contains=STORM&PageSize=20"
}
```
```

--------------------------------

### List Services with Node.js

Source: https://www.twilio.com/docs/notify/api/service-resource

Node.js example using the Twilio helper library to list up to 20 Service resources. Requires TWILIO_ACCOUNT_SID, TWILIO_API_KEY, and TWILIO_API_SECRET environment variables.

```javascript
// Download the helper library from https://www.twilio.com/docs/node/install
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

// Find your Account SID at twilio.com/console
// Provision API Keys at twilio.com/console/runtime/api-keys
// and set the environment variables. See http://twil.io/secure
// For local testing, you can use your Account SID and Auth token
const accountSid = process.env.TWILIO_ACCOUNT_SID;
const apiKey = process.env.TWILIO_API_KEY;
const apiSecret = process.env.TWILIO_API_SECRET;
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

async function listService() {
  const services = await client.notify.v1.services.list({ limit: 20 });

  services.forEach((s) => console.log(s.sid));
}

listService();
```

--------------------------------

### Fetch a Credential with C#

Source: https://www.twilio.com/docs/notify/api/credential-resource

C# example using the Twilio helper library to fetch a Credential resource. Requires TWILIO_API_KEY, TWILIO_API_SECRET, and TWILIO_ACCOUNT_SID environment variables.

```csharp
// Install the C# / .NET helper library from twilio.com/docs/csharp/install

using System;
using Twilio;
using Twilio.Rest.Notify.V1;
using System.Threading.Tasks;

class Program {
    public static async Task Main(string[] args) {
        // Find your Account SID at twilio.com/console
        // Provision API Keys at twilio.com/console/runtime/api-keys
        // and set the environment variables. See http://twil.io/secure
        // For local testing, you can use your Account SID and Auth token
        string apiKey = Environment.GetEnvironmentVariable("TWILIO_API_KEY");
        string apiSecret = Environment.GetEnvironmentVariable("TWILIO_API_SECRET");
        string accountSid = Environment.GetEnvironmentVariable("TWILIO_ACCOUNT_SID");

        TwilioClient.Init(apiKey, apiSecret, accountSid);

        var credential =
            await CredentialResource.FetchAsync(pathSid: "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa");

        Console.WriteLine(credential.Sid);
    }
}
```

--------------------------------

### GET /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Local.json

Source: https://www.twilio.com/docs/phone-numbers/api/availablephonenumberlocal-resource

This snippet documents the HTTP API endpoint for listing available local phone numbers, including the request parameters and example.

```APIDOC
## [GET] /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Local.json

### Description
Retrieves a list of available local phone numbers for a given country, with optional filters such as SMS and voice enabled, and address requirements.

### Method
GET

### Endpoint
`https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Local.json`

### Parameters
#### Path Parameters
- **AccountSid** (string) - Required - Your Twilio Account SID.
- **CountryCode** (string) - Required - The ISO country code (e.g., GB, US).

#### Query Parameters
- **SmsEnabled** (boolean) - Optional - Whether the phone number can send and receive SMS messages.
- **VoiceEnabled** (boolean) - Optional - Whether the phone number can send and receive voice calls.
- **PageSize** (integer) - Optional - The number of results to return per page.
- **ExcludeAllAddressRequired** (boolean) - Optional - Whether to exclude phone numbers that require address requirements.
- **Limit** (integer) - Optional - The maximum number of records to return.

### Request Example
```bash
curl -X GET "https://api.twilio.com/2010-04-01/Accounts/$TWILIO_ACCOUNT_SID/AvailablePhoneNumbers/GB/Local.json?SmsEnabled=true&VoiceEnabled=true&PageSize=20" \
-u $TWILIO_API_KEY:$TWILIO_API_SECRET
```

### Response
#### Success Response (200)
Returns a list of available local phone numbers with their properties.

#### Response Example
```json
{
  "available_phone_numbers": [
    {
      "phone_number": "+14155551234",
      "friendly_name": "(415) 555-1234",
      "locality": "San Francisco",
      "region": "CA",
      "postal_code": "94105",
      "iso_country": "US",
      "address_requirements": "none",
      "capabilities": {
        "voice": true,
        "SMS": true,
        "MMS": true
      }
    }
  ]
}
```
```

--------------------------------

### Find mobile numbers with pattern in Java

Source: https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-mobile-resource

Java helper library example that lists mobile numbers in the UK starting with +441225. Uses API key and secret from environment variables.

```java
// Install the Java helper library from twilio.com/docs/java/install

import com.twilio.Twilio;
import com.twilio.rest.api.v2010.account.availablephonenumbercountry.Mobile;
import com.twilio.base.ResourceSet;

public class Example {
    // Find your Account SID at twilio.com/console
    // Provision API Keys at twilio.com/console/runtime/api-keys
    // and set the environment variables. See http://twil.io/secure
    // For local testing, you can use your Account SID and Auth token
    public static final String API_KEY = System.getenv("TWILIO_API_KEY");
    public static final String API_SECRET = System.getenv("TWILIO_API_SECRET");
    public static final String ACCOUNT_SID = System.getenv("TWILIO_ACCOUNT_SID");

    public static void main(String[] args) {
        Twilio.init(API_KEY, API_SECRET, ACCOUNT_SID);
        ResourceSet<Mobile> mobiles = Mobile.reader("GB").setContains("+441225").limit(20).read();

        for (Mobile record : mobiles) {
            System.out.println(record.getEnd());
        }
    }
}
```

--------------------------------

### Environment variables for Prism example

Source: https://www.twilio.com/docs/openapi/mock-api-generation-with-twilio-openapi-spec

Environment variables required by the example: Twilio Account SID, API Key, API Secret, and destination/source phone numbers. Replace with your own valid credentials.

```bash
# .env
TWILIO_ACCOUNT_SID=ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
TWILIO_API_KEY=SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
TWILIO_API_SECRET=your_api_secret
TO_NUMBER=+12345678901
FROM_NUMBER=+12345678901
```

--------------------------------

### Find mobile numbers with pattern in Python

Source: https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-mobile-resource

Python helper library example that lists mobile numbers in the UK starting with +441225. Uses API key and secret from environment variables.

```python
# Download the helper library from https://www.twilio.com/docs/python/install
import os
from twilio.rest import Client

# Find your Account SID at twilio.com/console
# Provision API Keys at twilio.com/console/runtime/api-keys
# and set the environment variables. See http://twil.io/secure
# For local testing, you can use your Account SID and Auth token
api_key = os.environ["TWILIO_API_KEY"]
api_secret = os.environ["TWILIO_API_SECRET"]
account_sid = os.environ["TWILIO_ACCOUNT_SID"]
client = Client(api_key, api_secret, account_sid)

mobiles = client.available_phone_numbers("GB").mobile.list(
    contains="+441225", limit=20
)

for record in mobiles:
    print(record.end)
```

--------------------------------

### Create a new Rust project with cargo new

Source: https://www.twilio.com/docs/openapi/generating-a-rust-client-for-twilios-api

Run this command from the same directory where you executed the codegen process to scaffold a new Rust project named 'twilio-rust-example'.

```bash
cargo new twilio-rust-example
```

--------------------------------

### Fetch Service with Node.js

Source: https://www.twilio.com/docs/notify/api/service-resource

Node.js example using the Twilio helper library to fetch a Service resource. Requires TWILIO_ACCOUNT_SID, TWILIO_API_KEY, and TWILIO_API_SECRET environment variables. Prints the service sid.

```javascript
// Download the helper library from https://www.twilio.com/docs/node/install
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

// Find your Account SID at twilio.com/console
// Provision API Keys at twilio.com/console/runtime/api-keys
// and set the environment variables. See http://twil.io/secure
// For local testing, you can use your Account SID and Auth token
const accountSid = process.env.TWILIO_ACCOUNT_SID;
const apiKey = process.env.TWILIO_API_KEY;
const apiSecret = process.env.TWILIO_API_SECRET;
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

async function fetchService() {
  const service = await client.notify.v1
    .services("ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
    .fetch();

  console.log(service.sid);
}

fetchService();
```

--------------------------------

### Find mobile numbers with pattern in Node.js

Source: https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-mobile-resource

Node.js helper library example that lists mobile numbers in the UK starting with +441225. Uses API key and secret from environment variables.

```js
// Download the helper library from https://www.twilio.com/docs/node/install
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

// Find your Account SID at twilio.com/console
// Provision API Keys at twilio.com/console/runtime/api-keys
// and set the environment variables. See http://twil.io/secure
// For local testing, you can use your Account SID and Auth token
const accountSid = process.env.TWILIO_ACCOUNT_SID;
const apiKey = process.env.TWILIO_API_KEY;
const apiSecret = process.env.TWILIO_API_SECRET;
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

async function listAvailablePhoneNumberMobile() {
  const mobiles = await client.availablePhoneNumbers("GB").mobile.list({
    contains: "+441225",
    limit: 20,
  });

  mobiles.forEach((m) => console.log(m.end));
}

listAvailablePhoneNumberMobile();
```
Tokens:
Raw