Automated processing of port-in phone number operations
Numbers///
- API reference
- Porting
- Update configuration
Create Configuration
Get Configuration
Update configuration
Porting API (1.0)
Download OpenAPI description
Overview
License
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
Bodyapplication/jsonrequired
Create Communication Configuration for a given project
The default time for porting in numbers. If you don't specify a time in the order this time will be used.
Example: "09:00:00"
- v1.0 of the porting API
https://porting.api.sinch.com/v1/projects/YOUR_project_id/configuration
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://porting.api.sinch.com/v1/projects/YOUR_project_id/configuration \
-H 'Content-Type: application/json' \
-d '{
"contact": {
"email": "name@email.com",
"name": "John Smith",
"phone": "+15559999"
},
"webhookUrl": "my.callback.server",
"defaultPortTime": "09:00:00",
"defaultPortTimeZone": "US/Eastern"
}'Response
application/json
{ "contact": { "email": "name@email.com", "name": "John Smith", "phone": "+15559999" }, "webhookUrl": "my.callback.server", "defaultPortTime": "09:00:00", "defaultPortTimeZone": "US/Eastern" }
- v1.0 of the porting API
https://porting.api.sinch.com/v1/projects/YOUR_project_id/configuration
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://porting.api.sinch.com/v1/projects/YOUR_project_id/configurationResponse
application/json
{ "contact": { "email": "name@email.com", "name": "John Smith", "phone": "+15559999" }, "webhookUrl": "my.callback.server", "defaultPortTime": "09:00:00", "defaultPortTimeZone": "US/Eastern" }
Bodyapplication/jsonrequired
Update default configurations for a given project
The default time for porting in numbers. If you don't specify a time in the order this time will be used.
Example: "09:00:00"
- v1.0 of the porting API
https://porting.api.sinch.com/v1/projects/YOUR_project_id/configuration
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
https://porting.api.sinch.com/v1/projects/YOUR_project_id/configuration \
-H 'Content-Type: application/json' \
-d '{
"contact": {
"email": "name@email.com",
"name": "John Smith",
"phone": "+15559999"
},
"webhookUrl": "my.callback.server",
"defaultPortTime": "09:00:00",
"defaultPortTimeZone": "US/Eastern"
}'Response
application/json
{ "contact": { "email": "name@email.com", "name": "John Smith", "phone": "+15559999" }, "webhookUrl": "my.callback.server", "defaultPortTime": "09:00:00", "defaultPortTimeZone": "US/Eastern" }
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