REST API: Porting Phone Numbers

Introduction

The REST API to port phone numbers to Twilio has the following key resources:

  1. The Port Orders instance resource represents a single port request comprising the phone number that the customer wishes to port to Twilio.
  2. The Port Order LOAs instance resource represents a single electronic Letter of Authorization (LOA) document that authorizes Twilio to port one or more phone number(s) to Twilio on behalf of the customer requesting the port. This instance resource is automatically created using the information that was submitted to Twilio when creating the corresponding Port Orders instance resource.
  3. The Port Orders list resource represents the list of all phone numbers that are associated with a Twilio account or subaccount, identified by an Account SID, and are in the process of porting to Twilio.
  4. The Port Order LOAs list resource represents the list of all Port Order LOA documents that are associated with a Twilio account or subaccount, identified by an Account SID. Starting a new port request with Twilio by issuing POST to the Port Orders list resource creates the corresponding Port Orders and Port Order LOAs instance resources.

Port Orders Instance Resource

The Port Orders instance resource represents a single port request comprising the phone number that the customer wishes to port to Twilio.

Resource URI

preview.twilio.com/porting/PortOrders/{PortOrderSid}

Resource Properties

PROPERTY DESCRIPTION
sid A 34 character string that uniquely identifies this resource.
number Porting phone number in this resource. This must be in E.164 format, e.g., +16175551212.
friendly_name A 64 character string that is a human readable text that describes this resource. By default, this is a nicely formatted version of the porting phone number.
status Status of this resource. It can hold one of the values: 1. CREATED, 2. PENDING, 3. SUBMITTED, 4. ACCEPTED, 5. COMPLETED, 6. CANCELED, 7. REJECTED, 9. FAILED, 9. REVIEW. See section entitled Port Orders Status Values for more information on each of these statuses.
date_created The date that this resource was created, given as ISO 8601 format.
date_updated The date that this resource was updated, given as ISO 8601 format.
loa_sid Port Order LOA instance subresource SID, which is a 34 character string that uniquely identifies the electronic LOA document associated with this resource.
iso_country The ISO 3166-1 alpha-2 country code, e.g., “US”, in the service address associated with the porting phone number.
region Name of the region in the service address associated with the porting phone number. This can be a 2 letter state code in US, e.g., “CA”.
city Name of the city in the service address associated with the porting phone number.
postal_code Zip or postal code in the service address associated with the porting phone number.
street Name of the street in the service address associated with the porting phone number.
company_name Name of the company that owns the porting phone number. Please note that this is the name we will use to populate the “Business Name” field in the LOA associated with this resource.
first_name First name of the person who owns the porting phone number. Please note that this is the name we will use to populate the “First Name” field in the LOA associated with this resource, and that this person must be the one who is authorized to and will sign this LOA.
last_name Last name of the person who owns the porting phone number. Please note that this is the name we will use to populate the “Last Name” field in the LOA associated with this resource, and that this person must be the one who is authorized to and will sign the LOA.
email Email address of the person who owns the porting phone number. Please note that this person must be the one who is authorized to and will sign the LOA.
status_updates_email Email address of the person who will receive status updates about the port order as it goes through the porting lifecycle. If this email is specified, then the email address specified in the "email" field will not receive any status updates and will only be used to sign the LOA.
ssn_last_four Last four digits of the social security number of the person who owns the porting phone number. Please note that this person must be the one who is authorized to and will sign the LOA. Also note that this field will not be returned as part of the API’s response to a GET request.
activation_date Desired Firm Order Commitment (FOC) date and time, i.e., the date and time at which the number will port. Please note that this will be overridden if the earliest possible FOC date is on a later date. This must be in ISO 8601 format. Please be sure to include both date and time in this field when requesting an activation date, e.g. "2017-07-10T07:48:59+00:00" or "2017-07-10T07:48:59Z".
submitted_date Date and time at which the port order request was submitted to Twilio's underlying provider/carrier. This is in ISO 8601 format.
billing_phone_number The main billing phone number on the account (with your current provider/carrier) that is associated with the porting phone number in this port request. This must be in E.164 format, e.g., +16175551212.
account_number Account number of the account (with the current provider/carrier) that is associated with the porting phone number. This is mandatory for Wireless numbers but optional for Landline and Toll Free numbers. Please note that this field will not be returned as part of the API’s response to a GET request.
pin_number PIN number of the account (with your current provider/carrier) that is associated with the porting phone number. This is mandatory for Wireless numbers but optional for Landline and Toll Free numbers. Please note that this field will not be returned as part of the API’s response to a GET request.
incoming_phone_number_sid Porting phone number SID, which is a 34 character string that uniquely identifies the porting phone number.
status_callback The URL that Twilio will POST to each time status of the port request changes. See section entitled Port Orders Status Callback Payload for the structure of the status callback payload.
cc_emails Array of email address(es) of the person/people whom Twilio should notify each time the port request status changes to one of Delivered, Failed, or Completed.
reason_code Unique integer code that represents the reason for status change in this resource.
reason A human readable text that describes the reason for change in status of this resource.
errors Array of all errors that this port request has ever encountered in its lifetime. Each error will have an associated timestamp indicating the date and time at which the error was encountered. See section entitled Port Orders Error for more information on the error object.
url The URL for this resource.

Port Order Status Callback Payload

PROPERTY DESCRIPTION
port_order_sid A 34 character string that uniquely identifies the Port Orders instance resource.
callback_type An array of types of callbacks. There are two types of callbacks: (1) status_update, and (2) activation_date_update. The type "status_update" means that there was a change in the status of the Port Order request. The type "activation_date_update" means that there was an update to the FOC date and time of the Port Order request. If both updates happen at the same time, this array will contain both strings: "status_update" and "activation_date_update".
status Status of the Port Order request. See Port Orders Status Values section for more information.
foc_date The FOC date and time of the Port Order request.
date_updated The date that this Port Order request was updated, given as ISO 8601 format.
phone_number_sid Porting phone number SID, which is a 34 character string that uniquely identifies the porting phone number.
errors An array of all errors that this port request has ever encountered in its lifetime. Each error will have an associated timestamp indicating the date and time at which the error was encountered. See section entitled Port Order Error for more information on the error object.

Port Order Status Values

STATUS DESCRIPTION
CREATED Twilio has received the port request and is determining whether the phone number can be ported to Twilio.
PENDING LOA for the port request has been generated, but the customer who requested the port has not signed the LOA yet.
SUBMITTED LOA for the port request has been signed, and the phone number has been submitted to Twilio’s underlying provider/carrier to start the porting process.
ACCEPTED Twilio’s underlying provider/carrier has accepted and started the porting process.
COMPLETED Porting process has completed, and the phone number is ready for use.
CANCELED Port request was canceled – generally by the end user/customer, but it can happen through Twilio-internal processes and from our underlying carrier's end as well. At this point, it is no longer possible to edit/re-submit this port request.
REJECTED Port request was rejected by the current provider/carrier of the phone number in this port request. At this point, it is no longer possible to re-submit the same port request.
FAILED Port request has failed. At this point, it is no longer possible to re-submit the same port request.
REVIEW Port request has entered a state that cannot be handled by the Porting API's normal workflow and is now being handled manually by a Twilio porting operator. As the port makes progress, we will send you updates with status changes as usual.

Port Order Error

PROPERTY DESCRIPTION
date The date and time when this error was encountered by the port order, given in ISO 8601 format.
code Unique integer code that represents the error encountered by the port order.
reason A human readable text that describes the error encountered by the port order.

Port Order Related Errors

CODE NAME DESCRIPTION
21801 Port Order: Missing Incoming Phone Number in E.164 format You didn’t specify a telephone number to port to Twilio.
21802 Port Order: Missing ISO 3166-1 alpha-2 Country Code of the Phone Number's Service Address with Current Provider You didn’t specify the country code in your porting telephone number’s Service Address as it appears in the Customer Service Record with your current telephone service provider.
21803 Port Order: Missing State or Region of the Phone Number's Service Address with Current Provider You didn’t specify the state or region in your porting telephone number’s Service Address as it appears in the Customer Service Record with your current telephone service provider.
21804 Port Order: Missing City of the Phone Number's Service Address with Current Provider You didn’t specify the city in your porting telephone number’s Service Address as it appears in the Customer Service Record with your current telephone service provider.
21805 Port Order: Missing Postal Code of the Phone Number's Service Address with Current Provider You didn’t specify the zip or postal Code in your porting telephone number’s Service Address as it appears in the Customer Service Record with your current telephone service provider.
21806 Port Order: Missing Street of the Phone Number's Service Address with Current Provider You didn’t specify the street name in your porting telephone number’s Service Address as it appears in the Customer Service Record with your current telephone service provider.
21807 Port Order: Missing First Name of Authorized Signatory You didn’t specify the first name of the person who owns the porting telephone phone number and is authorized to sign the associated Letter of Authorization.
21808 Port Order: Missing Last Name of Authorized Signatory You didn’t specify the last name of the person who owns the porting telephone phone number and is authorized to sign the associated Letter of Authorization.
21809 Port Order: Missing Account Number (for Wireless Numbers only) You didn’t specify the account number associated with the porting telephone phone number. This is mandatory for Wireless numbers but optional for Landline and Toll Free numbers.
21810 Port Order: Missing PIN Number (for Wireless Numbers only) You didn’t specify the PIN associated with the porting telephone phone number. This is mandatory for Wireless numbers but optional for Landline and Toll Free numbers.
21811 Port Order: Missing Email Address of Authorized Signatory (for signing of LOA) You didn’t specify the email address associated with the porting telephone phone number.
21812 Port Order: Invalid Incoming Phone Number (must be in E.164 format) The porting telephone number you provided is not valid. This must be in E.164 format, e.g., “+16175551212”.
21813 Port Order: Invalid Country Code (must be in ISO 3166-1 alpha-2 format) The country code in your porting telephone number’s Service Address is not valid. This must be in ISO 3166-1 alpha-2 format, e.g., “US”.
21814 Port Order: Invalid Activation Date (must be in ISO 8601 format) The desired activation or Firm Order Commitment (FOC) date and time, i.e., the date and time at which the number will port, you provided is not valid. This must be in ISO 8601 format.
21815 Port Order: Invalid Billing Phone Number (must be in E.164 format) The billing telephone number you provided is not valid. This must be in E.164 format, e.g., “+16175551212”.
21816 Port Order: Invalid PIN Number The PIN number you provided is not valid.
21817 Port Order: Invalid Last Four digits of Social Security Number The last 4 digits of the social security number you provided is not valid.
21818 Port Order: Invalid Email Address The email address you provided is not valid.
21819 Port Order: Invalid Callback URL The callback URL you provided is not valid.
21820 Port Order: Invalid Email Address(es) in CC List (must be an array of valid Email Addresses) One or more of the email address(es) you provided is/are not valid.
21822 Port Order: Invalid Status The status you provided is not valid. See section entitled Port Orders Status Values for more information on each of these statuses.
21824 Port Order: Missing Last Four digits of Social Security Number You didn’t specify the last four digits of social security number of the person who owns the porting telephone phone number and is authorized to and will sign the associated Letter of Authorization. This is mandatory for Wireless numbers but optional for Landline and Toll Free numbers.
21825 Port Order: Invalid Before SID The SID you provided is not valid.
21826 Port Order: Invalid After SID The SID you provided is not valid.
21827 Port Order: Incoming Phone Number is not Portable The telephone number is not portable. This might be because the number already exists in Twilio, or because the number can’t be supported by Twilio.
21828 Port Order: Invalid Name of Authorized Signatory The first name and/or last name of the person, who owns the porting telephone number and is authorized to and will sign the associated Letter of Authorization, you provided is not valid.
21829 Port Order: Port Order cannot be Changed This port request can no longer be modified. Port Orders instance resources can be modified so long as they are in either “Created” or “Received” status.
21830 Port Order: Port Order cannot be Canceled This port request can no longer be canceled. Port requests cannot be canceled once they reach the “Completed” status.
21831 Port Order: Port is not Possible This port request has been rejected by your current telephone service provider. Please refer to Why was my port request rejected? for more information.
21832 Port Order: Port Orders with Wireless Phone Numbers cannot be canceled after LOA is signed This port request can no longer be canceled. Wireless port requests can be canceled so long as they are in one of “Created”, “Received”, or “Submitting” status.
21833 Port Order: Port Order cannot be Canceled since FOC date and time is in less than 48 hours This port request can no longer be canceled since the FOC date and time, i.e., the date and time at which the number will port, is in less than 48 hours.
21834 Port Order: Invalid Address: The given Street of the Phone Number's Service Address does not match the given City, State, and/or Postal Code The street name you provided does not exist in the City, State, and/or Postal Code you provided in the Port Order.
21835 Port Order: Port Order cannot be Completed Your port order cannot be completed. This is because either Twilio's underlying carrier isn't set up to support the porting phone number or your current carrier has rejected the port request.
21836 Port Order: Missing Account Number (for Wireless Numbers only) and Missing Last Four digits of Social Security Number (for Wireless Numbers only) You didn’t specify the account number associated with and the last four digits of social security number of the person who owns the porting telephone phone number. This is mandatory for Wireless numbers but optional for Landline and Toll Free numbers.
21837 Port Order: Incoming Phone Number is already in the porting process with an existing Port Order The porting phone number is part of a Letter of Authorization that has already been signed.
21838 Port Order: Incoming Phone Number is already in Twilio Inventory. Please contact Support The porting phone number is already in Twilio Inventory and cannot be ported. Please contact Support.

HTTP GET

Returns a single, existing Port Orders instance resource specified by the requested Port Orders instance resource SID, or {PortOrderSid}

Example
Request
$ curl -G https://preview.twilio.com/porting/PortOrders/PO800f449d0399ed014aae2bcc0cc2f2ec \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
Response
{
    "last_name": "Smith",
    "date_updated": "2017-07-05T11:29:34Z",
    "cc_emails": ["blah@twilio.com", "porting@twilio.com"],
    "number": "+14153077754",
    "incoming_phone_number_sid": "PN00f449d0399ed014aae2bcc0cc245lf",
    "street": "645 Random St",
    "postal_code": "94107",
    "port_type": "UNKNOWN",
    "city": "San Francisco",
    "first_name": "Jim",
    "errors": [{
      "code": 21835,
      "date": "2017-07-05T11:29:30.627Z",
      "reason": "Unable to port in number [14153077754] - number exists as an LRN."
    },...]
    "company_name": "Random Inc",
    "sid": "PO800f449d0399ed014aae2bcc0cc2f2ec",
    "activation_date": "2017-07-025T11:29:34Z",
    "email": "jim.smith@random.com",
    "status_updates_email": "joe.smith@random.com",
    "status": "REJECTED",
    "current_carrier": "Some Carrier",
    "billing_phone_number": null,
    "url": "https://preview.dev.twilio.com/porting/PortOrders/POb6e35c042f7689baf321b1f84be6a053",
    "earliest_activation_date": null,
    "loa_sid": "PX0fff0afcc9eda017f42674b7a0cc9f38",
    "friendly_name": "Random123",
    "iso_country": "US",
    "account_number": "7754",
    "date_created": "2017-07-05T11:28:38Z",
    "region": "CA",
    "status_callback": "http://someurl.io"
}

HTTP POST/PUT

Tries to update a single, existing Port Orders instance resource’s properties and returns the updated resource representation if successful. The returned response is identical to that returned when making a GET request. Please note that the existing Port Orders instance resource’s properties that hold the service address values and FOC dates can be updated only when the resource is in either “CREATED” or "REJECTED" status.

HTTP DELETE

Cancels the port request (consequently, also cancels the porting of the phone number in this port request) and sets the status on this Port Orders instance resource to “CANCELED”. The returned response is identical to that returned above when making a GET request.

Port Order LOAs Instance Resource

The “Port Order LOAs” instance resource represents a single electronic Letter of Authorization (LOA) document that authorizes Twilio to port one or more phone numbers to Twilio on behalf of the customer requesting the port. This instance resource is automatically created using the information that was submitted to Twilio when creating the corresponding Port Orders instance resource.

Resource URI

preview.twilio.com/porting/Loas/{PortLOASid}

Resource Properties

PROPERTY DESCRIPTION
sid A 34 character string that uniquely identifies this resource.
status Status of this resource. It can hold one of the values: 1. open, 2. signing, 3. signed, or 4. canceled
uri The URI for this resource, relative to https://preview.twilio.com

Port Order LOA Related Errors

CODE NAME DESCRIPTION
21901 Port Order LOA: Invalid SID The SID you provided is not valid.
21904 Port Order LOA: Invalid Status The status you provided is not valid.
21905 Port Order LOA: Signature Request has already been sent The LOA has already been signed.

HTTP GET

Returns a single, existing Port Order LOA instance resource specified by the requested Port Order LOA instance resource SID, or {PortLOASid}.

Example
Request
$ curl -G https://preview.twilio.com/porting/Loas/PX800f449d0399ed014aae2bcc0cc2f2ec \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
Response
{
    "status": "signing",
    "first_name": "Jim",
    "last_name": "Smith",
    "sid": "PX800f449d0399ed014aae2bcc0cc2f2ec",
    "email": "jim.smith@random.com"
}

HTTP POST

Issuing POST to this resource with an empty body will update a single, existing Port Order LOAs instance resource associated with one or more port requests and initiate the LOA signing process. This will send an email to the email address that was provided with associated port requests. Please note that a single Port Order LOAs instance resource is associated with multiple Port Orders instance resource(s) that share the same name, address, type of port, and Twilio account.

Example
Request
$ curl -XPOST https://preview.twilio.com/porting/Loas/PX800f449d0399ed014aae2bcc0cc2f2ec \ 
    -H "Content-Type: application/json" \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token' \
    -d ''
Response

The returned response is identical to that returned above when making a GET request.

HTTP PUT

Not available

HTTP DELETE

Not available

Port Orders List Resource

The Port Orders list resource represents the list of all phone numbers that are associated with a Twilio account or subaccount, identified by an Account SID, and are in the process of porting to Twilio.

Resource URI

preview.twilio.com/porting/PortOrders

List Filters

You may limit the list by providing certain query string parameters to the list resource. Note that the parameters are case-sensitive.

PARAMETER DESCRIPTION
Sid Retrieves the port order with this 34 character string that uniquely identifies the resource.
AccountSid Retrieves the list of port orders associated with an account that is uniquely identified by this 34 character string.
CompanyName Retrieves the list of port orders associated with the company with this name.
Email Retrieves the list of port orders with numbers owned by the person with this email address.
LoaSid Retrieves the list of port orders associated with an LOA that is uniquely identified by this 34 character string.
ProviderSid Retrieves the list of port orders with numbers that have been or will be hosted by a provider that is uniquely identified by this 34 character string.
ZendeskId Retrieves the list of port orders associated with a Zendesk ticket that is uniquely identified by this 32 character string.
ActivationDateMin Retrieves the list of port orders that have activated or will activate after this date and time, specified in ISO 8601 format.
ActivationDateMax Retrieves the list of port orders that have activated or will activate prior to this date and time, specified in ISO 8601 format.
IncomingPhoneNumberSid Retrieves the list of port orders with phone number that is uniquely identified by this 34 character string.
Number Retrieves the list of port orders with this phone number. This must be in E.164 format, e.g., +16175551212.
Status Retrieves the list of port orders in this state. It can hold one of the values: 1. CREATED, 2. PENDING, 3. SUBMITTED, 4. ACCEPTED, 5. COMPLETED, 6. CANCELED, 7. REJECTED, 9. FAILED, 9. REVIEW.
FriendlyName Retrieves the list of port orders with this friendly name.
PageSize Retrieves these many port orders.
BeforeSid Retrieves the list of port orders before the port order with this SID in the list of all port orders.
AfterSid Retrieves the list of port orders after the port order with this SID in the list of all port orders.

HTTP GET

Returns the list of all port orders that have the friendly name, “Random123”.

Example
Request
$ curl -G https://preview.twilio.com/porting/PortOrders \ 
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token' \
    -d "FriendlyName=Random123" \
Response
{
    "meta": {
      "page": 0,
      "page_size": 50,
      "first_page_url": "https://preview.twilio.com/porting/PortOrders?PageSize=50&Page=0",
      "previous_page_url": null,
      "url": "https://preview.twilio.com/porting/PortOrders?PageSize=50&Page=0",
      "next_page_url": "https://preview.dev.twilio.com/porting/PortOrders?PageSize=50&Page=1",
      "key": "orders"
    },
    "orders": [{
      "last_name": "Smith",
      "date_updated": "2017-07-05T11:29:34Z",
      "cc_emails": ["blah@twilio.com", "porting@twilio.com"],
      "number": "+14153077754",
      "incoming_phone_number_sid": "PN00f449d0399ed014aae2bcc0cc245lf",
      "street": "645 Random St",
      "postal_code": "94107",
      "port_type": "UNKNOWN",
      "city": "San Francisco",
      "first_name": "Jim",
      "errors": [{
        "code": 21835,
        "date": "2017-07-05T11:29:30.627Z",
        "reason": "Unable to port in number [14153077754] - number exists as an LRN."
      },...],
      "company_name": "Random Inc",
      "sid": "PO800f449d0399ed014aae2bcc0cc2f2ec",
      "activation_date": "2017-07-025T11:29:34Z",
      "email": "jim.smith@random.com",
      "status_updates_email": "joe.smith@random.com",
      "status": "REJECTED",
      "current_carrier": "Some Carrier",
      "billing_phone_number": null,
      "url": "https://preview.dev.twilio.com/porting/PortOrders/POb6e35c042f7689baf321b1f84be6a053",
      "earliest_activation_date": null,
      "loa_sid": "PX0fff0afcc9eda017f42674b7a0cc9f38",
      "friendly_name": "Random123",
      "iso_country": "US",
      "account_number": "7754",
      "date_created": "2017-07-05T11:28:38Z",
      "region": "CA",
      "status_callback": "http://someurl.io"
    },...]
}

HTTP POST

Initiates a single, new port request by creating a single, new Port Orders instance resource comprising the phone number to be ported to Twilio.

Required Parameters

PARAMETER DESCRIPTION
number Porting phone number in E.164 format, e.g., +16175551212.
iso_country The ISO 3166-1 alpha-2 country code in the service address associated with the porting phone number, e.g., US.
region Name of the region in the service address associated with the porting phone number. This can be a 2 letter state code in US, e.g., CA.
city Name of the city in the service address associated with the porting phone number.
postal_code Zip code or postal code in the service address associated with the porting phone number.
street Name of the street in the service address associated with the porting phone number.
first_name First name of the person that owns the porting phone number. Please note that this is the name we will use to populate the “First Name” field in the LOA associated with this port request, and that this person must be the one who is authorized to and will sign the LOA.
last_name Last name of the person that owns the porting phone number. Please note that this is the name we will use to populate the “Last Name” field in the LOA associated with this port request, and that this person must be the one who is authorized to and will sign the LOA.
email Email address of the person that owns the porting phone number. Please note that this person must be the one who is authorized to and will sign the LOA.

Optional Parameters

PARAMETER DESCRIPTION
friendly_name A human readable descriptive text for this resource, up to 64 characters long. By default, this is a nicely formatted version of the phone number.
company_name Name of the company that owns the porting phone number. Please note that this is the name we will use to populate the “Business Name” field in the LOA associated with this port request.
billing_phone_number The main billing phone number on the account (with your current provider/carrier) that is associated with the porting phone number in this port request. This must be in E.164 format, e.g., +16175551212.
account_number Account number of the account (with your current provider/carrier) that is associated with the porting phone number in this port request. This is mandatory for Wireless numbers but optional for Landline and Toll Free numbers.
pin_number PIN number of the account (with your current provider/carrier) that is associated with the porting phone number in this port request. This is mandatory for Wireless numbers but optional for Landline and Toll Free numbers.
ssn_last_four Last four digits of the social security number of the person that owns the porting phone number. Please note that this person must be the one who is authorized to and will sign the LOA. This is mandatory for Wireless numbers but optional for Landline and Toll Free numbers.
activation_date Desired Firm Order Commitment (FOC) date and time, given as ISO 8601 format – i.e., the date and time at which the number will port. This will be overridden if the earliest possible FOC date is on a later date.
status_callback The URL that Twilio will POST to each time the port request status changes to one of Delivered, Failed, or Completed.
status_updates_email Email address of the person who will receive status updates about the port order as it goes through the porting lifecycle. If this email is specified, then the email address specified in the "email" field will not receive any status updates and will only be used to sign the LOA.
cc_emails Array of email address(es) of the person/people whom Twilio should notify each time the port request status changes to one of Delivered, Failed, or Completed.
Example
Request
$ curl -XPOST https://preview.twilio.com/porting/PortOrders \
    -H "Content-Type: application/json" \
    -d '{"number":"+14153077754","iso_country":"US","region":"CA","city":"SAN FRANCISCO","postal_code":94107,"street":"645 Harrison st.","first_name":"James","last_name":"The Third","email":"james.thethird@random.com"}'  \
    -u "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token"
Response

The returned response is identical to that returned on issuing a GET request to Port Orders instance resource.

HTTP PUT

Not available

HTTP DELETE

Not available

Port Order LOAs List Resource

The Port Order LOAs list resource represents the list of all Port Order LOA documents that are associated with a Twilio account or subaccount, identified by an Account SID.

Resource URI

preview.twilio.com/porting/Loas

List Filters

You may limit the list by providing certain query string parameters to the list resource. Note that the parameters are case-sensitive.

PARAMETER DESCRIPTION
Sid Retrieves the LOA document with this 34 character string that uniquely identifies the resource.
Status Retrieves the list of Port Order LOA documents in this state. It can hold one of the values: 1. OPEN, 2. SIGNING, 3. SIGNED, 4. CANCELED, and 5. REVIEW.
FirstName Retrieves the list of Port Order LOA documents with numbers owned by the person with this first name.
LastName Retrieves the list of Port Order LOA documents with numbers owned by the person with this last name.
email Retrieves the list of Port Order LOA documents with numbers owned by the person with this email address.
BeforeSid Retrieves the list of Port Order LOA documents before the port order with this SID in the list of all port orders.
AfterSid Retrieves the list of Port Order LOA documents after the port order with this SID in the list of all port orders.
PageSize Retrieves these many Port Order LOA documents.

HTTP GET

Returns the list of all Port Order LOA documents that are associated with a Twilio account or subaccount, identified by an Account SID.

Example
Request
$ curl -G https://preview.twilio.com/porting/Loas \ 
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token' \
Response
{
    "meta": {
      "page": 0,
      "page_size": 50,
      "url": "https://preview.twilio.com/porting/Loas?PageSize=50&Page=0",
      "first_page_url": "https://preview.dev.twilio.com/porting/Loas?PageSize=50&Page=0",
      "next_page_url": "https://preview.dev.twilio.com/porting/Loas?PageSize=50&Page=1",
      "previous_page_url": null,
      "key": "loas"
    },
    "loas": [{
      "status": "open",
      "first_name": "Jim",
      "last_name": "Smith",
      "url": "https://preview.twilio.com/porting/Loas/PX0fff0afcc9eda017f42674b7a0cc9f38",
      "sid": "PX0fff0afcc9eda017f42674b7a0cc9f38",
      "email": "jim.smith@random.com"
    },...]
}

HTTP POST

Not available

HTTP PUT

Not available

HTTP DELETE

Not available

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.