List All IncomingPhoneNumbers

Use this endpoint for the IncomingPhoneNumber method to read all of the IncomingPhoneNumbers that are associated with your CPaaS account. This will be returned as a list of IncomingPhoneNumbers.

Parameters

Parameter	Description
AccountSid Required	The unique identifier of the account associated with this phone number.
Beta Optional	Shows new CPaaS numbers. Possible values are true or false. Default is true.
FriendlyName Optional	Shows numbers that exactly match the provided friendly name.
Origin Optional	Shows numbers that have the provided origin. CPaaS numbers are denoted as signalwire while hosted numbers are denoted as hosted.
PhoneNumber Optional	Shows the numbers that exactly match the provided pattern.

---

Request

cURL

curl https://example.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json \
  -X GET \
  -u "YourProjectID:YourAuthToken"

Node.js

const { RestClient } = require('@signalwire/compatibility-api')
const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })

client.incomingPhoneNumbers.each(incomingPhoneNumbers => console.log(incomingPhoneNumbers.sid));

C#

using System;
using System.Collections.Generic;
using Twilio;
using Twilio.Rest.Api.V2010.Account;

class Program
{
    static void Main(string[] args)
    {
        TwilioClient.Init("YourProjectID", "YourAuthToken", new Dictionary<string, object> { ["signalwireSpaceUrl"] = "{SPACE}.signalwire.com" });

        var incomingPhoneNumbers = IncomingPhoneNumberResource.Read();

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

Python

from signalwire.rest import Client as signalwire_client

client = signalwire_client("YourProjectID", "YourAuthToken", signalwire_space_url = 'example.signalwire.com')

incoming_phone_numbers = client.incoming_phone_numbers.list()

for record in incoming_phone_numbers:
    print(record.sid)

Ruby

require 'signalwire/sdk'

@client = Signalwire::REST::Client.new 'YourProjectID', 'YourAuthToken', signalwire_space_url: "example.signalwire.com"

incoming_phone_numbers = @client.incoming_phone_numbers.list

incoming_phone_numbers.each do |record|
  puts record.sid
end

---

Responses

200 OK

{
  "end": 0,
  "first_page_uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/IncomingPhoneNumbers.json?PageSize=1&Page=0",
  "incoming_phone_numbers": [
    {
      "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
      "address_requirements": "none",
      "address_sid": "b3877c40-da60-4998-90ad-b792e98472ad",
      "api_version": "2010-04-01",
      "beta": false,
      "capabilities": {
        "mms": true,
        "sms": false,
        "voice": true
      },
      "date_created": "Tue, 25 Sept 2018 23:00:00 +0000",
      "date_updated": "Wed, 26 Sept 2018 22:00:00 +0000",
      "emergency_address_sid": null,
      "emergency_status": "Inactive",
      "friendly_name": "310-338-6745",
      "identity_sid": "b3877c40-da60-4998-90ad-b792e98472ri",
      "origin": "origin",
      "phone_number": "+13103386745",
      "sid": "b3877c40-da60-4998-90ad-b792e98472pn",
      "sms_application_sid": null,
      "sms_fallback_method": "POST",
      "sms_fallback_url": "",
      "sms_method": "POST",
      "sms_url": "",
      "status_callback": "",
      "status_callback_method": "POST",
      "trunk_sid": "b3877c40-da60-4998-90ad-b792e98472tr",
      "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/IncomingPhoneNumbers/b3877c40-da60-4998-90ad-b792e98472pn.json",
      "voice_application_sid": null,
      "voice_caller_id_lookup": false,
      "voice_fallback_method": "POST",
      "voice_fallback_url": null,
      "voice_method": "GET",
      "voice_url": "http://your-application.com/docs/voice.xml"
    }
  ],
  "last_page_uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/IncomingPhoneNumbers.json?PageSize=1&Page=2",
  "next_page_uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/IncomingPhoneNumbers.json?PageSize=1&Page=1",
  "num_pages": 3,
  "page": 0,
  "page_size": 1,
  "previous_page_uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/IncomingPhoneNumbers.json?PageSize=1&Page=0",
  "start": 0,
  "total": 3,
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/IncomingPhoneNumbers.json?PageSize=1",
  "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac"
}