Incoming numbers

Q: How do you search for available phone numbers to purchase on FreeClimb?
A: Send a GET request to /Accounts/{accountId}/AvailablePhoneNumbers with query parameters such as phoneNumber, region, country, or capabilities (voice/SMS).

Q: How do you purchase and assign an incoming phone number to a FreeClimb account?
A: Send a POST request to /Accounts/{accountId}/IncomingPhoneNumbers supplying the desired phoneNumber and an optional alias or applicationId.

Q: How do you list all active phone numbers owned by a FreeClimb account?
A: Send a GET request to /Accounts/{accountId}/IncomingPhoneNumbers.

Q: How do you view details for a specific purchased incoming phone number?
A: Send a GET request to /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId}.

Q: How do you update settings or reassign an application for an incoming phone number?
A: Send a POST request to /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} with an updated applicationId or alias.

Q: How do you release or delete a phone number from a FreeClimb account?
A: Send a DELETE request to /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId}.

This is the collection of all the phone numbers that you have purchased from FreeClimb and which now belong to the account. These phone numbers can receive and send calls.

Resource properties

An Incoming number resource is represented by the following properties:

PropertyTypeDescription
uristringURI for this resource, relative to /apiserver.
dateCreatedstring date-timeDate that this resource was created (GMT), in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT).
dateUpdatedstring date-timeDate that this resource was last updated (GMT), in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT).
dateCreatedISOstring date-timeDate that this resource was created (UTC) in RFC3339 format (e.g., 2024-10-09T15:05:03.358Z).
dateUpdatedISOstring date-timeDate that this resource was last updated (UTC) in RFC3339 format (e.g., 2024-10-09T15:05:03.358Z).
revisionintegerRevision count for the resource. This count is set to 1 on creation and is incremented every time it is updated.
phoneNumberIdstringString that uniquely identifies this phone number resource.
accountIdstringID of the account that owns this phone number.
applicationIdstringID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId.
phoneNumberstringPhone number in E.164 format.
aliasstringDescription for this phone number. Typically the conventionally-formatted version of the phone number.
regionstringState or province of this phone number.
countrystringCountry of this phone number.
capabilitiesobjectIndicates whether the phone number is enabled for different features. Capabilities list: voice, sms, tollFree, tenDLC, shortcode, pft, webRTC,. Each capability accepts a boolean value of true or false.
campaignIdstringThe 10DLC campaign ID associated with the phone number, if applicable. Phone numbers with no associated campaign ID will be null.
campaignAssignmentTimestring date-timeDate that this resource was assigned to a Campaign (GMT), in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT).
offnetbooleanIndicates whether the phone number was registered as an offnet number. Offnet numbers may have certain restrictions on the platform.