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.

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

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.

SecuritybasicAuth or bearerAuth
Request
path Parameters
orderId
required
string
Example: 897867
Responses
200

Successful operation

Response Schema: application/json
Array
phoneNumberGroup
string
focDate
string
Array of objects
Array
phoneNumber
string
RTC (object) or EST (object) or FAX (object) (VoiceConfiguration)
object (SmsConfiguration)

Configuration for what sms service id to use, and other sms related configurations

get/orders/portIns/{orderId}/availableActivations
Request samples
Response samples
application/json
[
  • {
    • "phoneNumberGroup": "GW Verizon Grp1",
    • "focDate": "string",
    • "phoneNumbers": [
      ]
    }
]

On demand activation

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.

SecuritybasicAuth or bearerAuth
Request
path Parameters
orderId
required
string
Example: 897867
Request Body schema: application/json
optional

Activate Port-In Order

phoneNumberGroups
Array of strings
Responses
200

Successful operation

Response Schema: application/json
Array of objects
Array
phoneNumberGroup
string
status
string
post/orders/portIns/{orderId}/activate
Request samples
application/json
{ }
Response samples
application/json
{
  • "phoneNumberGroups": [
    • {
      }
    ]
}