Skip to content
Numbers/
/
/
On demand activation

Porting API (1.0)

Automated processing of port-in phone number operations

Download OpenAPI description
porting.json
porting.yaml
Overview
License

MIT

Languages
Servers
v1.0 of the porting API

https://porting.api.sinch.com/v1/projects/{projectId}/

Port-in numbers

You can create orders, check portability, and more. When you port in phone numbers to Sinch you need to make sure the numbers are portable, you can use the portability check to make sure the numbers are portable before creating an order. If a number is not portable the whole order will fail. When porting a number to Sinch you can either use the dashboard or the API, the API is recommended for larger orders and for automation.

Note: For port orders of over 500 numbers, please contact the support team.

The recommended way to port numbers to Sinch is to schedule the port, this means that you create an order and specify a desired port date and time, If you have more advanced needs like on-demand activation, you can read more about that in the advanced porting section.

Operations

Webhooks

Webhooks

Port-in settings

Porting default settings

Operations

Advanced porting

This section is for advanced porting operations, like on demand activating numbers, getting available numbers for activation, and more. If you are looking for basic porting operations like creating an order, checking portability, and more, please refer to the Port-in numbers section.

Operations

Scheduled ports

The recommended way to port numbers to Sinch is to schedule the port, this means that you create an order and specify a desired port date and time, this is the date you want the numbers to be ported in to Sinch automatically and we will sync with the loosing carrier to make sure the port is done on that date with minimal downtime for you and your customers.

On demand ports

If you need to control your self when a number is activated you can use on demand ports, that means as soon as the number is confirmed you can activate it when you want. And we take care of the rest. When using on demand ports you need to make sure the number is confirmed and released for activation. you can also choose to activate numbers on activation groups.

Activation groups

When you create a port in order we assign an activating group on the numbers, the grouping is by carrier so if you have a large port-in order from multiple different carriers you can group and look at the numbers by group to see status. Updates to port order usually comes on group basis and are confirmed ro rejected on carrier level.

You can also use this as a way to activate groups for on-demand activation. However we recommend you porting in numbers by carrier to make sure you get the best experience.

On demand activation

When you set up an order with onDemandActivation set to true, you can activate the numbers when you want. This is useful if you want to control when the numbers are activated.

You can activate a whole order by calling /orders/portins/{orderId}/activate or you can activate a specific group of numbers by calling /orders/portins/{orderId}/activate with the phoneNumberGroup you find on the number. Please note that it is not possible to activate single numbers by order or activation group.

List port-in activation groups

Request

Retrieve Port-In Order Available Activation Groups This operation allows you to get a list of phone number groups currently available for activation on a port-in order. FOC (portDate) must be today or earlier, and the numbers must be in routing on the Sinch network.

Security
basicAuth or bearerAuth
Path
orderIdstringrequired
Example: 897867
curl -i -X GET \
  -u <username>:<password> \
  https://porting.api.sinch.com/v1/projects/YOUR_project_id/orders/portIns/897867/availableActivations

Responses

Successful operation

Bodyapplication/jsonArray [
phoneNumberGroupstring
Example: "GW Verizon Grp1"
focDatestring
phoneNumbersArray of objects
]
Response
application/json
[
  {
    "phoneNumberGroup": "GW Verizon Grp1",
    "focDate": "string",
    "phoneNumbers": [ … ]
  }
]

On demand activation

Request

Activate numbers that are ready to be ported. Confirmation date (FOC) must be today or earlier, and the numbers must be in routing on the Sinch network (occurs at midnight on the date of the port, after concurrence, or following the 18-hour wireline port timer expiration on expedited ports).

Note: In order to send SMS and MMS messages in the US using 10DLC phone numbers, all messages must be sent via an approved campaign. Your campaigns are managed under US 10DLC Campaigns in the SMS section. A number can be associated to an approved campaign after the port completes.

Security
basicAuth or bearerAuth
Path
orderIdstringrequired
Example: 897867
Bodyapplication/json

If you want to only activate certain numbers in the order, include this request body with the phone numbers you want to activate.

phoneNumberGroupsArray of strings
Example: ["+17775559999"]
curl -i -X POST \
  -u <username>:<password> \
  https://porting.api.sinch.com/v1/projects/YOUR_project_id/orders/portIns/897867/activate \
  -H 'Content-Type: application/json' \
  -d '{
    "phoneNumberGroups": [
      "+17775559999"
    ]
  }'

Responses

Successful operation

Bodyapplication/json
phoneNumberGroupsArray of objects

A group of phone numbers to be ported in.

Response
application/json
{
  "phoneNumberGroups": [
    { … }
  ]
}