API REFERENCEv1

Create Number

POSThttps://api2.protexting.com/v1/numbers/create

⌘

Pass your server-side token as access_token. Replace sample values with your own. Authentication & setup →

Example

1* if the account is set with credit card billing, you will be able to create 1 long code every 2 minutes, otherwise the transaction will be declined.

Request parameters:

* required parameters

Parameter	Description
* Country	String,The two character country code in ISO 3166-1 alpha-2 format. see here »
Prefix	String, Starts with prefix to search for create.

Response parameters:

Parameter	Description
Number	String
Status_Id	Integer, view statuses »
Status_Description	String, view statuses »
Blocked_Date	String, Date Time

Example Request:

Request example

1# Set PROTEXTING_ACCESS_TOKEN in your environment2curl --request POST \3  "https://api2.protexting.com/v1/numbers/create?access_token=${PROTEXTING_ACCESS_TOKEN:?Set your API token}" \4  --header 'Accept: application/json' \5  --header 'Content-Type: application/json' \6  --data '{7  "Country": "US",8  "Prefix": "64634"9}'

Server-side exampleJSON · HTTPS

Example Response Headers:

Response headers example

1Status Code: 201 Created
2Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
3Connection: Keep-Alive
4Content-Length: 243
5Content-Type: application/json; charset=UTF-8
6Keep-Alive: timeout=5, max=100
7Pragma: no-cache
8X-Powered-By: PHP/5.6.2
9X-Rate-Limit-Limit: 60
10X-Rate-Limit-Remaining: 59
11X-Rate-Limit-Reset

Example Response Body:

JSON response example

1{
2    "Number":16463498xxx,
3    "Status_Id": 0,4    "Status_Description":"Active",5    "Blocked_Date" : null
6}

XML response example

1<response>
2    <Number>16463498xxx</Number>
3    <Status_Id>0</Status_Id>4    <Status_Description>Active</Status_Description>5    <Blocked_Date/>6</response>

HTTP Status Codes:

The standard HTTP Status Codes are used. More information is available here: http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

Error Codes:

Error Codes and Examples here »

Statuses:

Status Id	Status Description
0	Active
1	Inactive
301	Temporarily blocked.
302	Permanently blocked.

← PreviousView Number Next →Delete Number

Reference from the ProTexting documentation catalog. Code examples are illustrative; this page does not execute API requests.